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

improve docu wording

Browse source
This commit is contained in:
tpo 2013-07-07 13:11:09 +02:00
commit 243106f513
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/man/man7/cdist-type.text
View file

@ -67,18 +67,18 @@ A type consists of
Types are stored below cdist/conf/type/. Their name should always be prefixed with Types are stored below cdist/conf/type/. Their name should always be prefixed with
two underscores (__) to prevent collisions with other executables in $PATH. two underscores (__) to prevent collisions with other executables in $PATH.
To begin a new type, just create the directory **cdist/conf/type/__NAME**. To implement a new type, create the directory **cdist/conf/type/__NAME**.
DEFINING PARAMETERS DEFINING PARAMETERS
------------------- -------------------
Every type consists of required, optional and boolean parameters, which must Every type consists of required, optional and boolean parameters, which must
be created in a newline separated file in ***parameter/required***, each be declared in a newline separated file in ***parameter/required***,
***parameter/required_multiple***, ***parameter/optional***, ***parameter/required_multiple***, ***parameter/optional***,
***parameter/optional_multiple*** and ***parameter/boolean***. ***parameter/optional_multiple*** and ***parameter/boolean***.
Parameters which are allowed multiple times should be listed in Parameters which are allowed multiple times should be listed in
required_multiple or optional_multiple respectively. For all other parameters required_multiple or optional_multiple respectively. All other parameters
the standard unix behaviour of the last given wins is applied. follow the standard unix behaviour "the last given wins".
If either is missing, the type will have no required, no optional, no boolean If either is missing, the type will have no required, no optional, no boolean
or no parameters at all. or no parameters at all.
@ -125,7 +125,7 @@ fi
INPUT FROM STDIN INPUT FROM STDIN
----------------- ----------------
Every type can access what has been written on stdin when it has been called. Every type can access what has been written on stdin when it has been called.
The result is saved into the ***stdin*** file in the object directory. The result is saved into the ***stdin*** file in the object directory.