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

[DOC] cleanups

Browse source 
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-02-19 02:02:21 +01:00
parent fa1764598e
commit 711fea9e7e
2 changed files with 23 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile
View file

@ -36,3 +36,4 @@ pub:
man: man:
echo $(MANSRC) echo $(MANSRC)
a2x -f manpage --no-xmllint doc/man/cdist-stages.text a2x -f manpage --no-xmllint doc/man/cdist-stages.text
echo man ./doc/man/cdist-stages.7

43
doc/man/cdist-stages.text
View file

@ -43,38 +43,39 @@ cdist-config-layout(7).
STAGE 3: EXECUTION OF TYPES STAGE 3: EXECUTION OF TYPES
--------------------------- ---------------------------
Every object is checked whether its type has an init Every object is checked whether its type has an init
script (see cdist-types(7)). If the type of the object script (see cdist-types(7)). If the type of the object
has an init script, it is run. This init script may has an init script, it is run. This init script may
generate additional objects. generate additional objects.
For instance the object __apache/www.test.ch is of For instance the object __apache/www.test.ch is of
type __apache, which may contain an init script, which type __apache, which may contain an init script, which
creates new objects of type __file. creates new objects of type __file.
The newly created objects are merged back into The newly created objects are merged back into
the existing tree. No conflicts may occur during the existing tree. No conflicts may occur during
the merge. A conflict would mean that two different the merge. A conflict would mean that two different
objects try to create the same object, which indicates a objects try to create the same object, which indicates a
broken configuration. broken configuration.
STAGE 4: CODE GENERATION STAGE 4: CODE GENERATION
------------------------ ------------------------
The "gencode" binary of the types for every existing object is The "gencode" binary of the types for every existing object is
called to generate code that will be executed on the target host. called to generate code that will be executed on the target host.
This binary should create code to be executed on the target on stdout. This binary should create code to be executed on the target on stdout.
If the gencode binary fails, it must print diagnostic messages on stderr If the gencode binary fails, it must print diagnostic messages on stderr
and exit non-zero. and exit non-zero.
A description of what the generated code may/must/should A description of what the generated code may/must/should
do can be found in cdist-types-gencode(7). do can be found in cdist-types-gencode(7).
STAGE 5: CODE EXECUTION STAGE 5: CODE EXECUTION
----------------------- -----------------------
The resulting code is transferred to the target host and executed,
the run of cdist-deploy-to(1) ends. The resulting code is transferred to the target host and executed,
the run of cdist-deploy-to(1) ends.
SEE ALSO SEE ALSO