rouxdo/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOC] add cdist-type manpage

Browse source 
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-03-08 20:35:21 +01:00
parent 7b2e815830
commit 45737ce452
2 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -15,13 +15,13 @@ MANSRC=$(MANDIR)/cdist-config-layout.text \
$(MANDIR)/cdist-quickstart.text \ $(MANDIR)/cdist-quickstart.text \
$(MANDIR)/cdist-stages.text \ $(MANDIR)/cdist-stages.text \
$(MANDIR)/cdist-terms.text \ $(MANDIR)/cdist-terms.text \
$(MANDIR)/cdist-type.text
MANSRC=$(MANDIR)/cdist.text \ MANSRC=$(MANDIR)/cdist.text \
$(MANDIR)/cdist-bin-transfer.text \ $(MANDIR)/cdist-bin-transfer.text \
$(MANDIR)/cdist-deploy-to.text \ $(MANDIR)/cdist-deploy-to.text \
$(MANDIR)/cdist-manifest.text \ $(MANDIR)/cdist-manifest.text \
$(MANDIR)/cdist-stages.text \ $(MANDIR)/cdist-stages.text \
$(MANDIR)/cdist-type.text \
$(MANDIR)/cdist-type-template.text \ $(MANDIR)/cdist-type-template.text \

25
doc/man/to_check/cdist-type.text → doc/man/cdist-type.text
View file

@ -98,6 +98,25 @@ to execute it.
THE TYPE EXPLORERS THE TYPE EXPLORERS
------------------ ------------------
If a type needs to explore specific details, it can provide type specific
explorers, which will be executed on the target for every created object.
The explorers are stored under the "explorer" directory below the type.
It could for instance contain code to check the md5sum of a file on the
client, like this (shortened version from real type __file):
--------------------------------------------------------------------------------
if [ -f "$__object/parameter/destination" ]; then
destination="$(cat "$__object/parameter/destination")"
else
destination="/$__object_id"
fi
if [ -e "$destination" ]; then
md5sum < "$destination"
fi
--------------------------------------------------------------------------------
WRITING THE GENCODE SCRIPT WRITING THE GENCODE SCRIPT
-------------------------- --------------------------
@ -132,8 +151,8 @@ If you think your type may be useful for others, ensure it works with the
current master branch of cdist and submit the git url containing the type for current master branch of cdist and submit the git url containing the type for
inclusion to the mailinglist **cdist at cdist -- at -- l.schottelius.org**. inclusion to the mailinglist **cdist at cdist -- at -- l.schottelius.org**.
Ensure there is a corresponding manpage named cdist-type-NAME (without Ensure a corresponding manpage named cdist-type-NAME (without
underscores) included. underscores) is included.
SEE ALSO SEE ALSO
@ -144,5 +163,5 @@ SEE ALSO
COPYING COPYING
------- -------
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is Copyright \(C) 2011 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3). granted under the terms of the GNU General Public License version 3 (GPLv3).