add explorer to reference documentation

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
14 years ago · a164d16ea4
parent 31c76f8a42
commit a164d16ea4
3 changed files with 14 additions and 7 deletions
--- a/doc/changelog
+++ b/doc/changelog
@ -1,3 +1,6 @@
+1.7.1:
+	* Add explorers to reference documentation
+
 1.7.0: 2011-05-10
 	* Bugfix type __package_yum: Fix redhat support (Ramon Salvadó)
 	* Improved type __package_yum: Add centos support (Ramon Salvadó)
--- a/doc/dev/todo/niconext
+++ b/doc/dev/todo/niconext
@ -1,5 +1,4 @@
 Cleanup documentation:
-   type reference -> add types + manpages
   add explorer reference

 - Catch broken instances in cdist-mass-deploy -p and report broken deployements at the end!
--- a/doc/man/cdist-reference.text.sh
+++ b/doc/man/cdist-reference.text.sh
@ -43,14 +43,19 @@ NAME
 cdist-reference - Variable, path and type reference for cdist


-DESCRIPTION
-----------
-This reference summarises
+EXPLORERS
+---------
+The following global explores are available:

- environment variables
- paths
- types 
+eof
+(
+   cd ../../conf/explorer
+   for explorer in *; do
+      echo "- $explorer"
+   done
+)

+cat << eof 

 PATHS
 -----