From 5d62370ff147e7a7dd327332bf1310c4ec00427c Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Tue, 8 Mar 2011 20:00:11 +0100 Subject: [PATCH] [DOC] begin documentation of environment variables Signed-off-by: Nico Schottelius --- doc/dev/todo/niconext | 1 + doc/dev/todo/post-1.0 | 13 ------------- doc/man/to_check/cdist-environment-variables.text | 14 ++++++++++++++ 3 files changed, 15 insertions(+), 13 deletions(-) create mode 100644 doc/man/to_check/cdist-environment-variables.text diff --git a/doc/dev/todo/niconext b/doc/dev/todo/niconext index 4f8f033d..52bc8041 100644 --- a/doc/dev/todo/niconext +++ b/doc/dev/todo/niconext @@ -1,5 +1,6 @@ Documentation cleanup - to_check/cdist-type.text + - document environment variables - cdist-type-integration - Ensure available types are documented (!) - define how to in cdist-type-integration diff --git a/doc/dev/todo/post-1.0 b/doc/dev/todo/post-1.0 index de8919f0..9d6031b4 100644 --- a/doc/dev/todo/post-1.0 +++ b/doc/dev/todo/post-1.0 @@ -38,12 +38,6 @@ Documentation: - via version control - Define how to raise errors in types - - = todo - + = in progress -> S|N - x = done - - - x remove old documentation from doc/man/! - Check all references in manpages, ensure all manpages exist, generic ones: + cdist + cdist-deploy-to @@ -53,13 +47,6 @@ Documentation: - install packages only if not existent - copy file only if different - DOC document that $type/manifest is executed for every object/instance - - exported variables: - - general explorer: __explorer # cdist-explorer - - initial manifest: __manifest, __global # cdist-manifest - - type manifests __object, __object_id, __global # cdist-type - - type explorers: __object, __object_id, __type_explorers # cdist-type - - type codegen: __object, __object_id, __global # cdist-type - - type code: - # cdist-code - category 7: - cdist-manifest(7) - cdist-explorer diff --git a/doc/man/to_check/cdist-environment-variables.text b/doc/man/to_check/cdist-environment-variables.text new file mode 100644 index 00000000..c91a2ae0 --- /dev/null +++ b/doc/man/to_check/cdist-environment-variables.text @@ -0,0 +1,14 @@ +Update on env: + + general explorer: __explorer + initial manifest: __manifest, __global + type manifests __object, __object_id, __global + type explorers: __object, __object_id, __type_explorers, __global + type codegen: __object, __object_id, __global + type code: - + + +- __object: Path to the object that we are working on +- __object_id: type unique object id +- __global: contains global information (see cdist-env +