From 711fea9e7ed2709b9e9b56a69058cb9a753e4b87 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 19 Feb 2011 02:02:21 +0100 Subject: [PATCH] [DOC] cleanups Signed-off-by: Nico Schottelius --- Makefile | 1 + doc/man/cdist-stages.text | 43 ++++++++++++++++++++------------------- 2 files changed, 23 insertions(+), 21 deletions(-) diff --git a/Makefile b/Makefile index 341f2eb5..e56f62c8 100644 --- a/Makefile +++ b/Makefile @@ -36,3 +36,4 @@ pub: man: echo $(MANSRC) a2x -f manpage --no-xmllint doc/man/cdist-stages.text + echo man ./doc/man/cdist-stages.7 diff --git a/doc/man/cdist-stages.text b/doc/man/cdist-stages.text index 98e42ece..960813f6 100644 --- a/doc/man/cdist-stages.text +++ b/doc/man/cdist-stages.text @@ -43,38 +43,39 @@ cdist-config-layout(7). STAGE 3: EXECUTION OF TYPES --------------------------- - Every object is checked whether its type has an init - script (see cdist-types(7)). If the type of the object - has an init script, it is run. This init script may - generate additional objects. +Every object is checked whether its type has an init +script (see cdist-types(7)). If the type of the object +has an init script, it is run. This init script may +generate additional objects. - For instance the object __apache/www.test.ch is of - type __apache, which may contain an init script, which - creates new objects of type __file. +For instance the object __apache/www.test.ch is of +type __apache, which may contain an init script, which +creates new objects of type __file. - The newly created objects are merged back into - the existing tree. No conflicts may occur during - the merge. A conflict would mean that two different - objects try to create the same object, which indicates a - broken configuration. +The newly created objects are merged back into +the existing tree. No conflicts may occur during +the merge. A conflict would mean that two different +objects try to create the same object, which indicates a +broken configuration. STAGE 4: CODE GENERATION ------------------------ - The "gencode" binary of the types for every existing object is - called to generate code that will be executed on the target host. +The "gencode" binary of the types for every existing object is +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 - and exit non-zero. +If the gencode binary fails, it must print diagnostic messages on stderr +and exit non-zero. - A description of what the generated code may/must/should - do can be found in cdist-types-gencode(7). +A description of what the generated code may/must/should +do can be found in cdist-types-gencode(7). 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