Merge pull request #2533 from mavimo/documentation-version_added

Double quoted version_added in documentation
This commit is contained in:
Michael DeHaan 2013-03-31 07:34:24 -07:00
commit 3461a0f777
22 changed files with 29 additions and 29 deletions

View file

@ -7,7 +7,7 @@ short_description: add a host (and alternatively a group) to the ansible-playboo
description:
- Use variables to create new hosts and groups in inventory for use in later plays of the same playbook.
Takes variables so you can define the new hosts more fully.
version_added: 0.9
version_added: "0.9"
options:
name:
description:

View file

@ -23,7 +23,7 @@ DOCUMENTATION = '''
---
module: apt_key
author: Jayson Vantuyl & others
version_added: 1.0
version_added: "1.0"
short_description: Add or remove an apt key
description:
- Add or remove an I(apt) key, optionally downloading it

4
copy
View file

@ -36,9 +36,9 @@ options:
default: null
aliases: []
content:
version_added: 1.1
version_added: "1.1"
description:
- When used instead of 'src', sets the contents of a file directly to the specified value. (New in 1.1).
- When used instead of 'src', sets the contents of a file directly to the specified value.
required: false
default: null
dest:

View file

@ -40,7 +40,7 @@ options:
required: false
default: null
virtualenv_site_packages:
version_added: 1.1
version_added: "1.1"
description:
- Whether the virtual environment will inherit packages from the
global site-packages directory. Note that if this setting is
@ -51,7 +51,7 @@ options:
default: "no"
choices: [ "yes", "no" ]
virtualenv_command:
version_added: 1.1
version_added: "1.1"
description:
- The command to create the virtual environment with. For example
C(pyvenv), C(virtualenv), C(virtualenv2).

4
fetch
View file

@ -28,9 +28,9 @@ options:
required: true
default: null
fail_on_missing:
version_added: 1.1
version_added: "1.1"
description:
- Makes it fails when the source file is missing. (Option is new in 1.1)
- Makes it fails when the source file is missing.
required: false
choices: [ "yes", "no" ]
default: "no"

2
git
View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
---
module: git
author: Michael DeHaan
version_added: 0.0.1
version_added: "0.0.1"
short_description: Deploy software (or files) from git checkouts
description:
- Manage I(git) checkouts of repositories to deploy files or software.

2
group
View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
---
module: group
author: Stephen Fromm
version_added: 0.0.2
version_added: "0.0.2"
short_description: Add or remove groups
requirements: [ groupadd, groupdel, groupmod ]
description:

View file

@ -6,7 +6,7 @@ module: group_by
short_description: Create Ansible groups based on facts
description:
- Use facts to create ad-hoc groups that can be used later in a playbook.
version_added: 0.9
version_added: "0.9"
options:
key:
description:

View file

@ -64,7 +64,7 @@ options:
required: false
default: "no"
choices: [ "yes", "no" ]
version_added: 1.1
version_added: "1.1"
description:
- Used with C(state=present). If set, line can contain backreferences
(both positional and named) that will get populated if the regexp
@ -84,7 +84,7 @@ options:
choices: [ 'EOF', '*regex*' ]
insertbefore:
required: false
version_added: 1.1
version_added: "1.1"
description:
- Used with C(state=present). If specified, the line will be inserted
before the specified regular expression. A value is available;

2
nagios
View file

@ -25,7 +25,7 @@ description:
- You can specify multiple services at once by separating them with commas, .e.g., C(services=httpd,nfs,puppet).
- When specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime for the I(host itself), e.g., C(service=host). This keyword may not be given with other services at the same time. I(Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.) To schedule downtime for all services on particular host use keyword "all", e.g., C(service=all).
- When using the M(nagios) module you will need to specify your Nagios server using the C(delegate_to) parameter.
version_added: 0.7
version_added: "0.7"
options:
action:
description:

View file

@ -24,7 +24,7 @@ DOCUMENTATION = '''
---
module: openbsd_pkg
author: Patrik Lundin
version_added: 1.1
version_added: "1.1"
short_description: Manage packages on OpenBSD.
description:
- Manage packages on OpenBSD using the pkg tools.

2
pause
View file

@ -8,7 +8,7 @@ description:
- Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt.
- "You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early: press C(ctrl+c) and then C(c). To abort a playbook: press C(ctrl+c) and then C(a)."
- "The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts."
version_added: 0.8
version_added: "0.8"
options:
minutes:
description:

4
pip
View file

@ -50,7 +50,7 @@ options:
required: false
default: null
virtualenv_site_packages:
version_added: 1.0
version_added: "1.0"
description:
- Whether the virtual environment will inherit packages from the
global site-packages directory. Note that if this setting is
@ -61,7 +61,7 @@ options:
default: "no"
choices: [ "yes", "no" ]
virtualenv_command:
version_aded: 1.1
version_aded: "1.1"
description:
- The command to create the virtual environment with. For example
C(pyvenv), C(virtualenv), C(virtualenv2).

View file

@ -24,7 +24,7 @@ module: rabbitmq_parameter
short_description: Adds or removes parameters to RabbitMQ
description:
- Manage dynamic, cluster-wide parameters for RabbitMQ
version_added: '1.1'
version_added: "1.1"
author: Chris Hoffman
options:
component:

View file

@ -24,7 +24,7 @@ module: rabbitmq_plugin
short_description: Adds or removes users to RabbitMQ
description:
- Enables or disables RabbitMQ plugins
version_added: 1.1
version_added: "1.1"
author: Chris Hoffman
options:
names:

View file

@ -24,7 +24,7 @@ module: rabbitmq_user
short_description: Adds or removes users to RabbitMQ
description:
- Add or remove users to RabbitMQ and assign permissions
version_added: 1.1
version_added: "1.1"
author: Chris Hoffman
options:
user:

View file

@ -25,8 +25,8 @@ module: rabbitmq_vhost
short_description: Manage the state of a virtual host in RabbitMQ
description:
- Manage the state of a virtual host in RabbitMQ
version_added: 1.1
author: Chris Hoffman
version_added: "1.1"
author: Chris Hoffman
options:
name:
description:

View file

@ -6,7 +6,7 @@ module: rhn_channel
short_description: Adds or removes Red Hat software channels
description:
- Adds or removes Red Hat software channels
version_added: '1.1'
version_added: "1.1"
author: Vincent Van der Kussen
notes:
- this module fetches the system id from RHN.

View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
---
module: service
author: Michael DeHaan
version_added: 0.1
version_added: "0.1"
short_description: Manage services.
description:
- Controls services on remote hosts.

2
setup
View file

@ -35,7 +35,7 @@ module: setup
short_description: Gathers facts about remote hosts
options:
filter:
version_added: 1.1
version_added: "1.1"
description:
- if supplied, only return facts that match this shell-style (fnmatch) wildcard.
required: false

View file

@ -29,7 +29,7 @@ description:
as a legacy feature in Solaris 11.
- Note that this is a very basic packaging system. It will not enforce
dependencies on install or remove.
version_added: 0.9
version_added: "0.9"
author: Boyd Adamson
options:
name:

4
user
View file

@ -22,7 +22,7 @@ DOCUMENTATION = '''
---
module: user
author: Stephen Fromm
version_added: 0.2
version_added: "0.2"
short_description: Manage user accounts
requirements: [ useradd, userdel, usermod ]
description:
@ -48,7 +48,7 @@ options:
description:
- Optionally when used with the -u option, this option allows to
change the user ID to a non-unique value.
(New in 1.1)
version_added: "1.1"
group:
required: false
description: