Update docs for types that used man.rst as symbolic links.

This commit is contained in:
Darko Poljak 2016-12-16 08:19:41 +01:00
commit 2b45405898
7 changed files with 234 additions and 10 deletions

View file

@ -51,6 +51,19 @@ Example:
__myfancysingleton --colour green
Config types
------------
By default types are used with config command. These are types that are not
flagged by any known command flag. If a type is marked then it will be skipped
with config command.
Install types
-------------
If a type is flagged with 'install' flag then it is used only with install command.
With other commands, i.e. config, these types are skipped if used.
How to write a new type
-----------------------
A type consists of
@ -209,6 +222,18 @@ As you can see, the object ID is omitted, because it does not make any sense,
if your type can be used only once.
Install - type with install command
-----------------------------------
If you want a type to be used with install command, you must mark it as
install: create the (empty) file "install" in your type directory:
.. code-block:: sh
touch cdist/conf/type/__install_NAME/install
With other commands, i.e. config, it will be skipped if used.
The type explorers
------------------
If a type needs to explore specific details, it can provide type specific