diff --git a/HACKERS_README b/HACKERS_README index 004b8612..4d194e0d 100755 --- a/HACKERS_README +++ b/HACKERS_README @@ -11,13 +11,19 @@ Do not believe anything written in cdist, besides what's written in this file -- Nico, 20101201 -What you can do so far: (executed from top level directory) +## Conventions -The following code will get executed if you run this README, -I usually do it like this: +- All variables exported by cdist are prefixed with a double underscore (__) +- All cdist-internal variables are prefixed with __cdist_ and are generally not exported. + +## Running cdist when developing + +This file is suitable for execution and saving the objects and +explorers from cdist. I usually do it like this: % rm -rf /tmp/localhost && ./HACKERS_README +################################################################################ eof # Tell the user what we do, so this script makes sense during execution diff --git a/TODO-1.0 b/TODO-1.0 index 5f4229a1..19b32ec7 100644 --- a/TODO-1.0 +++ b/TODO-1.0 @@ -43,6 +43,7 @@ x generate code to be executed on clients (stage 4) x execute code on client (stage 5) - Last doc stuff for 1.0.0: + - remove old documentation from doc/man/! - ensure every file in bin/ has a correspondent manpage - cdist-quickstart [WRITE] - how to write a minimal host manifest diff --git a/doc/man/cdist-environment.text b/doc/man/cdist-environment.text deleted file mode 100644 index 4e8109ae..00000000 --- a/doc/man/cdist-environment.text +++ /dev/null @@ -1,32 +0,0 @@ -cdist-environment(7) -==================== -Nico Schottelius - - -NAME ----- -cdist-environment - Which environment cdist sets up - - -DESCRIPTION ------------ - -PREFIXES --------- - -These prefixes are supposed to be used. If you write a new type, you -should stick to these conventions. - -- __: All variables setup by cdist are prefixed with a double _ -- __cdist_: Variables setup by the cdist core -- ___: Variable setup by type - - -EXAPMLES --------- - - -COPYING -------- -Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is -granted under the terms of the GNU General Public License version 3 (GPLv3).