From f586f933abb27ba92851db5a4d605202bc14d1bb Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 20 Nov 2014 20:00:16 -0400 Subject: update --- doc/README.mdwn | 5 ----- doc/debugging.mdwn | 6 ++++++ doc/documentation.mdwn | 12 ++++++++++++ doc/index.mdwn | 1 + 4 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 doc/debugging.mdwn create mode 100644 doc/documentation.mdwn (limited to 'doc') diff --git a/doc/README.mdwn b/doc/README.mdwn index c509ccdc..3ced98f6 100644 --- a/doc/README.mdwn +++ b/doc/README.mdwn @@ -55,8 +55,3 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask 8. Optionally, set up a [centralized git repository](https://propellor.branchable.com/centralized_git_repository/) so that multiple hosts can be updated with a simple `git commit -S; git push` 9. Write some neat new properties and send patches! - -## debugging - -Set `PROPELLOR_DEBUG=1` to make propellor print out all the commands it runs -and any other debug messages that Properties choose to emit. diff --git a/doc/debugging.mdwn b/doc/debugging.mdwn new file mode 100644 index 00000000..f656ac43 --- /dev/null +++ b/doc/debugging.mdwn @@ -0,0 +1,6 @@ +Set `PROPELLOR_DEBUG=1` to make propellor print out all the commands it runs +and any other debug messages that Properties choose to emit. + +Another handy debugging tip is to load up your config.hs in ghci, and look +at `hosts`. This will show the Properties of a Host, as well as the Info +associated with it, etc. diff --git a/doc/documentation.mdwn b/doc/documentation.mdwn new file mode 100644 index 00000000..79e242f4 --- /dev/null +++ b/doc/documentation.mdwn @@ -0,0 +1,12 @@ +The [API documentation](http://hackage.haskell.org/package/propellor) of +Propellor's modules is the most important docuemntation of propellor. + +Other documentation: + +* [[Haskell Newbie]] +* [[Centralized Git Repository]] +* [[Contributing]] +* [[Interface Stability]] +* [[Coding Stye]] +* [[Security]] +* [[Debugging]] diff --git a/doc/index.mdwn b/doc/index.mdwn index 160eb1ae..246deed2 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -4,6 +4,7 @@ [[Install]] [API documentation](http://hackage.haskell.org/package/propellor) [Sample config file](http://git.joeyh.name/?p=propellor.git;a=blob;f=config-joey.hs) +[[Documentation]] [[Security]] [[Todo]] [[Forum]] -- cgit v1.2.3