documentation cleanups
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
parent
91eccc8920
commit
3d4bb3837f
15 changed files with 31 additions and 32 deletions
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
--------
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
--------
|
||||
|
|
|
@ -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
|
||||
--------
|
||||
|
|
|
@ -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
|
||||
--------
|
||||
|
|
|
@ -24,7 +24,7 @@ None.
|
|||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
state::
|
||||
'present' or 'absent', defaults to 'present'
|
||||
Either "present" or "absent", defaults to "present"
|
||||
|
||||
|
||||
EXAMPLES
|
||||
|
|
Loading…
Reference in a new issue