[type/__uci*] Update man.rst regarding quoting requirements
This commit is contained in:
parent
8728817af6
commit
4aebb1f127
2 changed files with 10 additions and 0 deletions
|
@ -23,6 +23,8 @@ value
|
||||||
Due to the way cdist handles arguments, values **must not** contain newline
|
Due to the way cdist handles arguments, values **must not** contain newline
|
||||||
characters.
|
characters.
|
||||||
|
|
||||||
|
Values do not need special quoting for UCI. The only requirement is that the
|
||||||
|
value is passed to the type as a single shell argument.
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
|
|
|
@ -34,6 +34,10 @@ list
|
||||||
same ``<option>`` repeatedly.
|
same ``<option>`` repeatedly.
|
||||||
|
|
||||||
The value to this parameter is a ``<option>=<value>`` string.
|
The value to this parameter is a ``<option>=<value>`` string.
|
||||||
|
|
||||||
|
``<value>`` does not need special quoting for UCI.
|
||||||
|
The only requirement is that the value is passed to the type as a single
|
||||||
|
shell argument.
|
||||||
match
|
match
|
||||||
Allows to find a section to "replace" through one of its parameters.
|
Allows to find a section to "replace" through one of its parameters.
|
||||||
|
|
||||||
|
@ -43,6 +47,10 @@ option
|
||||||
This parameter can be used multiple times to specify multiple options.
|
This parameter can be used multiple times to specify multiple options.
|
||||||
|
|
||||||
The value to this parameter is a ``<option>=<value>`` string.
|
The value to this parameter is a ``<option>=<value>`` string.
|
||||||
|
|
||||||
|
``<value>`` does not need special quoting for UCI.
|
||||||
|
The only requirement is that the value is passed to the type as a single
|
||||||
|
shell argument.
|
||||||
state
|
state
|
||||||
``present`` or ``absent``, defaults to ``present``.
|
``present`` or ``absent``, defaults to ``present``.
|
||||||
transaction
|
transaction
|
||||||
|
|
Loading…
Reference in a new issue