first round of absent/present changes

Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
Nico Schottelius 2012-02-08 22:16:09 +01:00
parent 5a64c89c8e
commit 242ce6dfd2
8 changed files with 40 additions and 33 deletions

View file

@ -1,5 +1,5 @@
cdist-type__user(7)
===================
cdist-type__package(7)
======================
Steven Armstrong <steven-cdist--@--armstrong.cc>
@ -17,22 +17,23 @@ It dispatches the actual work to the package system dependant types.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "installed" or "removed"
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
The name of the package to install. Default is to use the object_id as the
package name.
The name of the package to install. Default is to use the object_id as the
package name.
version::
The version of the package to install. Default is to install the version
choosen by the local package manager.
The version of the package to install. Default is to install the version
choosen by the local package manager.
type::
The package type to use. Default is determined based on the $os explorer
variable.
e.g. __package_apt for Debian
__package_emerge for Gentoo
The package type to use. Default is determined based on the $os explorer
variable.
e.g. __package_apt for Debian
__package_emerge for Gentoo
EXAMPLES
@ -40,13 +41,13 @@ EXAMPLES
--------------------------------------------------------------------------------
# Install the package vim on the target
__package vim --state installed
__package vim --state present
# Same but install specific version
__package vim --state installed --version 7.3.50
__package vim --state present --version 7.3.50
# Force use of a specific package type
__package vim --state installed --type __package_apt
__package vim --state present --type __package_apt
--------------------------------------------------------------------------------

View file

@ -17,7 +17,8 @@ manage packages.
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
@ -31,13 +32,13 @@ EXAMPLES
--------------------------------------------------------------------------------
# Ensure zsh in installed
__package_apt zsh --state installed
__package_apt zsh --state present
# In case you only want *a* webserver, but don't care which one
__package_apt webserver --state installed --name nginx
__package_apt webserver --state present --name nginx
# Remove obsolete package
__package_apt puppet --state removed
__package_apt puppet --state absent
--------------------------------------------------------------------------------

View file

@ -1,5 +1,5 @@
cdist-type__package_luarocks(7)
==============================
===============================
Christian G. Warden <cwarden@xerus.org>
@ -16,13 +16,14 @@ LuaRocks is a deployment and management system for Lua modules.
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
EXAMPLES

View file

@ -17,13 +17,14 @@ packages.
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
EXAMPLES
@ -49,5 +50,5 @@ SEE ALSO
COPYING
-------
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).

View file

@ -23,10 +23,10 @@ state::
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
pip::
Instead of using pip from PATH, use the specific pip path.
Instead of using pip from PATH, use the specific pip path.
EXAMPLES

View file

@ -16,16 +16,17 @@ This type is usually used on OpenBSD to manage packages.
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
flavor::
If supplied, use to avoid ambiguity.
If supplied, use to avoid ambiguity.
EXAMPLES

View file

@ -16,13 +16,14 @@ Rubygems is the default package management system for the Ruby programming langu
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
EXAMPLES

View file

@ -18,13 +18,14 @@ slightly confusing error message "Error: Nothing to do".
REQUIRED PARAMETERS
-------------------
state::
Either "installed" or "removed".
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
OPTIONAL PARAMETERS
-------------------
name::
If supplied, use the name and not the object id as the package name.
If supplied, use the name and not the object id as the package name.
EXAMPLES