From 3d4bb3837f073d820c833267e19a0ffd3f25d20b Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 7 Nov 2012 19:22:02 +0100 Subject: [PATCH] documentation cleanups Signed-off-by: Nico Schottelius --- cdist/conf/type/__package/man.text | 2 +- cdist/conf/type/__package_apt/man.text | 2 +- cdist/conf/type/__package_luarocks/man.text | 2 +- cdist/conf/type/__package_opkg/man.text | 2 +- cdist/conf/type/__package_pacman/man.text | 5 ++--- cdist/conf/type/__package_pip/man.text | 2 +- cdist/conf/type/__pf_ruleset/man.text | 1 + cdist/conf/type/__postgres_role/man.text | 2 +- cdist/conf/type/__process/man.text | 14 +++++++------- cdist/conf/type/__qemu_img/man.text | 3 +-- cdist/conf/type/__rvm/man.text | 2 +- cdist/conf/type/__rvm_gem/man.text | 8 ++++---- cdist/conf/type/__rvm_gemset/man.text | 6 +++--- cdist/conf/type/__rvm_ruby/man.text | 10 +++++----- cdist/conf/type/__start_on_boot/man.text | 2 +- 15 files changed, 31 insertions(+), 32 deletions(-) diff --git a/cdist/conf/type/__package/man.text b/cdist/conf/type/__package/man.text index 229ccf92..b656c890 100644 --- a/cdist/conf/type/__package/man.text +++ b/cdist/conf/type/__package/man.text @@ -34,7 +34,7 @@ type:: __package_emerge for Gentoo state:: - either "present" or "absent", defaults to "present" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__package_apt/man.text b/cdist/conf/type/__package_apt/man.text index 35c34d33..5d4656c1 100644 --- a/cdist/conf/type/__package_apt/man.text +++ b/cdist/conf/type/__package_apt/man.text @@ -25,7 +25,7 @@ name:: If supplied, use the name and not the object id as the package name. state:: - The state the package should be in, either "present" or "absent" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__package_luarocks/man.text b/cdist/conf/type/__package_luarocks/man.text index 18a80a79..657f68e5 100644 --- a/cdist/conf/type/__package_luarocks/man.text +++ b/cdist/conf/type/__package_luarocks/man.text @@ -24,7 +24,7 @@ name:: If supplied, use the name and not the object id as the package name. state:: - The state the package should be in, either "present" or "absent" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__package_opkg/man.text b/cdist/conf/type/__package_opkg/man.text index 3d02d1ce..aeb0a1c5 100644 --- a/cdist/conf/type/__package_opkg/man.text +++ b/cdist/conf/type/__package_opkg/man.text @@ -24,7 +24,7 @@ name:: If supplied, use the name and not the object id as the package name. state:: - The state the package should be in, either "present" or "absent" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__package_pacman/man.text b/cdist/conf/type/__package_pacman/man.text index 17c2037a..2e24ecd9 100644 --- a/cdist/conf/type/__package_pacman/man.text +++ b/cdist/conf/type/__package_pacman/man.text @@ -10,8 +10,7 @@ cdist-type__package_pacman - Manage packages with pacman DESCRIPTION ----------- -Pacman is usually used on the Archlinux distribution to manage -packages. +Pacman is usually used on the Archlinux distribution to manage packages. REQUIRED PARAMETERS @@ -25,7 +24,7 @@ name:: If supplied, use the name and not the object id as the package name. state:: - The state the package should be in, either "present" or "absent" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__package_pip/man.text b/cdist/conf/type/__package_pip/man.text index 8cb7d80a..5f619871 100644 --- a/cdist/conf/type/__package_pip/man.text +++ b/cdist/conf/type/__package_pip/man.text @@ -28,7 +28,7 @@ pip:: Instead of using pip from PATH, use the specific pip path. state:: - Either "present" or "absent", defaults to "present" + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__pf_ruleset/man.text b/cdist/conf/type/__pf_ruleset/man.text index 5c368e77..0dc07f71 100644 --- a/cdist/conf/type/__pf_ruleset/man.text +++ b/cdist/conf/type/__pf_ruleset/man.text @@ -26,6 +26,7 @@ source:: Note that this type is almost useless without a ruleset defined, but it's technically not needed, e.g. for the case of disabling the firewall temporarily. + EXAMPLES -------- diff --git a/cdist/conf/type/__postgres_role/man.text b/cdist/conf/type/__postgres_role/man.text index 4f13fa53..904f0831 100644 --- a/cdist/conf/type/__postgres_role/man.text +++ b/cdist/conf/type/__postgres_role/man.text @@ -16,7 +16,7 @@ This cdist type allows you to create or drop postgres roles. REQUIRED PARAMETERS ------------------- state:: - either 'present' or 'absent' + Either "present" or "absent", defaults to "present" OPTIONAL PARAMETERS diff --git a/cdist/conf/type/__process/man.text b/cdist/conf/type/__process/man.text index 929ba6a0..0d457ead 100644 --- a/cdist/conf/type/__process/man.text +++ b/cdist/conf/type/__process/man.text @@ -16,23 +16,23 @@ This cdist type allows you to define the state of a process. REQUIRED PARAMETERS ------------------- state:: - State of the process: Either present or absent + Either "present" or "absent", defaults to "present" OPTIONAL PARAMETERS ------------------- name:: - Process name to match on when using pgrep -f -x. + Process name to match on when using pgrep -f -x. - This is useful, if the name starts with a "/", - because the leading slash is stripped away from - the object id by cdist. + This is useful, if the name starts with a "/", + because the leading slash is stripped away from + the object id by cdist. stop:: - Executable to use for stopping the process. + Executable to use for stopping the process. start:: - Executable to use for starting the process. + Executable to use for starting the process. EXAMPLES diff --git a/cdist/conf/type/__qemu_img/man.text b/cdist/conf/type/__qemu_img/man.text index 3e16f957..39188ab0 100644 --- a/cdist/conf/type/__qemu_img/man.text +++ b/cdist/conf/type/__qemu_img/man.text @@ -24,8 +24,7 @@ size:: OPTIONAL PARAMETERS ------------------- state:: - The state of the image file: either "present" or "absent". - Defaults to "present". + Either "present" or "absent", defaults to "present" EXAMPLES diff --git a/cdist/conf/type/__rvm/man.text b/cdist/conf/type/__rvm/man.text index 0a355dc6..c1f83e60 100644 --- a/cdist/conf/type/__rvm/man.text +++ b/cdist/conf/type/__rvm/man.text @@ -16,7 +16,7 @@ RVM is the Ruby enVironment Manager for the Ruby programming language. REQUIRED PARAMETERS ------------------- state:: - Either "present" or "absent". + Either "present" or "absent". EXAMPLES diff --git a/cdist/conf/type/__rvm_gem/man.text b/cdist/conf/type/__rvm_gem/man.text index 85b52d65..fbf9a622 100644 --- a/cdist/conf/type/__rvm_gem/man.text +++ b/cdist/conf/type/__rvm_gem/man.text @@ -16,16 +16,16 @@ RVM is the Ruby enVironment Manager for the Ruby programming language. REQUIRED PARAMETERS ------------------- user:: - The remote user account to use + The remote user account to use gemset:: - The gemset to use + The gemset to use state:: - Either "present" or "absent". + Either "present" or "absent" OPTIONAL PARAMETERS ------------------- default:: - Make the selected gemset the default + Make the selected gemset the default EXAMPLES -------- diff --git a/cdist/conf/type/__rvm_gemset/man.text b/cdist/conf/type/__rvm_gemset/man.text index 10b6b411..26e866ba 100644 --- a/cdist/conf/type/__rvm_gemset/man.text +++ b/cdist/conf/type/__rvm_gemset/man.text @@ -16,14 +16,14 @@ RVM is the Ruby enVironment Manager for the Ruby programming language. REQUIRED PARAMETERS ------------------- user:: - The remote user account to use + The remote user account to use state:: - Either "present" or "absent". + Either "present" or "absent". OPTIONAL PARAMETERS ------------------- default:: - If set to anything but "no" (the default), set the given gemset as default. + If set to anything but "no" (the default), set the given gemset as default. EXAMPLES -------- diff --git a/cdist/conf/type/__rvm_ruby/man.text b/cdist/conf/type/__rvm_ruby/man.text index c558cfe3..90a7b654 100644 --- a/cdist/conf/type/__rvm_ruby/man.text +++ b/cdist/conf/type/__rvm_ruby/man.text @@ -16,14 +16,14 @@ RVM is the Ruby enVironment Manager for the Ruby programming language. REQUIRED PARAMETERS ------------------- user:: - The remote user account to use + The remote user account to use state:: - Either "present" or "absent". + Either "present" or "absent". -OPTIONAL PARAMETERS -------------------- +BOOLEAN PARAMETERS +------------------ default: - If set to anything but "no" (the default), set the given version as default + If set to anything but "no" (the default), set the given version as default EXAMPLES -------- diff --git a/cdist/conf/type/__start_on_boot/man.text b/cdist/conf/type/__start_on_boot/man.text index 58a68d65..6d804884 100644 --- a/cdist/conf/type/__start_on_boot/man.text +++ b/cdist/conf/type/__start_on_boot/man.text @@ -24,7 +24,7 @@ None. OPTIONAL PARAMETERS ------------------- state:: - 'present' or 'absent', defaults to 'present' + Either "present" or "absent", defaults to "present" EXAMPLES