matthijs/cdist
1
0
Fork 0
forked from ungleich-public/cdist
Code Issues Pull requests Projects Releases Wiki Activity

Add support for deprecated type parameters

Browse source
This commit is contained in:
Darko Poljak 2019-06-19 18:19:32 +02:00
commit 55ba49efac
7 changed files with 67 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/src/cdist-type.rst
View file

@ -74,7 +74,7 @@ prevents to be run in more than one instance.
Deprecated types
-----------------
If a type is flagged with 'deprecated' marker then it is considered deprecated.
Upon it's usage cdist writes warning line. If 'deprecated' marker has content
When it is used cdist writes warning line. If 'deprecated' marker has content
then this content is printed as a deprecation messages, e.g.:
.. code-block:: sh
@ -186,6 +186,28 @@ Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest)
fi
Deprecated parameters
---------------------
To deprecate type parameters one can declare a newline separated file
**parameter/deprecated** where each line contains deprecated parameter.
When it is used cdist writes warning line, e.g.:
.. code-block:: sh
$ cat parameter/optional_multiple
foo
spam
eggs
$ cat parameter/deprecated
spam
eggs
$ echo '__foo foo --foo foo --spam spam' | ./bin/cdist config -i - 185.203.112.26
WARNING: 185.203.112.26: spam parameter of type __foo is deprecated, see man page for details
$ echo '__foo foo --foo foo --eggs eggs --spam spam' | ./bin/cdist config -i - 185.203.112.26
WARNING: 185.203.112.26: spam parameter of type __foo is deprecated, see man page for details
WARNING: 185.203.112.26: eggs parameter of type __foo is deprecated, see man page for details
Input from stdin
----------------
Every type can access what has been written on stdin when it has been called.