diff --git a/cdist/conf/type/__uci/man.rst b/cdist/conf/type/__uci/man.rst index 2f64355b..cf184f9d 100644 --- a/cdist/conf/type/__uci/man.rst +++ b/cdist/conf/type/__uci/man.rst @@ -3,23 +3,22 @@ cdist-type__uci(7) NAME ---- -cdist-type__uci - Manage configuration values in OpenWrt's -Unified Configuration Interface (UCI) +cdist-type__uci - Manage configuration values in UCI DESCRIPTION ----------- -This cdist type can be used to alter configuration options in OpenWrt's UCI -system. +This cdist type can be used to alter configuration options in OpenWrt's +Unified Configuration Interface (UCI) system. -Options can be applied in batches if the `--transaction` parameter is used. +Options can be applied in batches if the ``--transaction`` parameter is used. REQUIRED PARAMETERS ------------------- value The value to be set. Can be used multiple times. - This parameter is allowed to be omitted if `--state` is `absent`. + This parameter is ignored if ``--state`` is ``absent``. Due to the way cdist handles arguments, values **must not** contain newline characters. @@ -28,10 +27,10 @@ value OPTIONAL PARAMETERS ------------------- state - `present` or `absent`, defaults to `present`. + ``present`` or ``absent``, defaults to ``present``. transaction The name of the transaction this option belongs to. - If none is given: "default" is used. + If none is given: ``default`` is used. BOOLEAN PARAMETERS diff --git a/cdist/conf/type/__uci_commit/man.rst b/cdist/conf/type/__uci_commit/man.rst index c55d06e5..ea6611eb 100644 --- a/cdist/conf/type/__uci_commit/man.rst +++ b/cdist/conf/type/__uci_commit/man.rst @@ -3,14 +3,16 @@ cdist-type__uci_commit(7) NAME ---- -cdist-type__uci_commit - Commit a UCI transaction. +cdist-type__uci_commit - Commit UCI transactions DESCRIPTION ----------- -This type executes the "uci commit" command on the target. -It is usually not required to use this type. Use the `--transaction` parameter -of `cdist-type__uci`\ (7) instead. +This type executes the ``uci commit`` command on the target with the commands +queued in a transaction. +It is usually not required to use this type. Use the ``--transaction`` parameter +of :strong:`cdist-type__uci`\ (7) and :strong:`cdist-type__uci_section`\ (7) +instead. REQUIRED PARAMETERS @@ -42,7 +44,7 @@ EXAMPLES SEE ALSO -------- -:strong:`cdist-type__uci`\ (7) +:strong:`cdist-type__uci`\ (7), :strong:`cdist-type__uci_section`\ (7) AUTHORS diff --git a/cdist/conf/type/__uci_section/man.rst b/cdist/conf/type/__uci_section/man.rst index 3468bfc3..86729316 100644 --- a/cdist/conf/type/__uci_section/man.rst +++ b/cdist/conf/type/__uci_section/man.rst @@ -3,21 +3,23 @@ cdist-type__uci_section(7) NAME ---- -cdist-type__uci_section - Manage configuration sections in OpenWrt's -Unified Configuration Interface (UCI) +cdist-type__uci_section - Manage configuration sections in UCI DESCRIPTION ----------- This cdist type can be used to replace whole configuration sections in OpenWrt's -UCI system. -It can be thought of as syntactic sugar for `cdist-type__uci`\ (7), as this type -will generate the required `__uci` objects to make the section contain exactly -the options specified via ``--option``. +Unified Configuration Interface (UCI) system. +It can be thought of as syntactic sugar for :strong:`cdist-type__uci`\ (7), +as this type will generate the required `__uci` objects to make the section +contain exactly the options specified using ``--option``. Since many default UCI sections are unnamed, this type allows to find the matching section by one of its options using the ``--match`` parameter. +**NOTE:** Options already present on the target and not listed in ``--option`` +or ``--list`` will be deleted. + REQUIRED PARAMETERS ------------------- @@ -28,18 +30,18 @@ OPTIONAL PARAMETERS ------------------- match Allows to find a section to "replace" through one of its parameters. - The value to this parameter is a ``