ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Improve documentation for pkgng module (#2338)

Browse source 
According to module checklist:

- Descriptions should always start with a Capital letter and end with a
  full stop.
- Ensure that you make use of U() for urls, C() for files and options,
  I() for params, M() for modules.
This commit is contained in:
Dmitry Marakasov 2016-05-31 20:58:55 +04:00 committed by Matt Clay
parent f61878fa80
commit a6ee449d6b
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
lib/ansible/modules/extras/packaging/os/pkgng.py
View file

@ -32,53 +32,53 @@ version_added: "1.2"
options: options:
name: name:
description: description:
- name of package to install/remove - Name of package to install/remove.
required: true required: true
state: state:
description: description:
- state of the package - State of the package.
choices: [ 'present', 'absent' ] choices: [ 'present', 'absent' ]
required: false required: false
default: present default: present
cached: cached:
description: description:
- use local package base or try to fetch an updated one - Use local package base instead of fetching an updated one.
choices: [ 'yes', 'no' ] choices: [ 'yes', 'no' ]
required: false required: false
default: no default: no
annotation: annotation:
description: description:
- a comma-separated list of keyvalue-pairs of the form - A comma-separated list of keyvalue-pairs of the form
<+/-/:><key>[=<value>]. A '+' denotes adding an annotation, a C(<+/-/:><key>[=<value>]). A C(+) denotes adding an annotation, a
'-' denotes removing an annotation, and ':' denotes modifying an C(-) denotes removing an annotation, and C(:) denotes modifying an
annotation. annotation.
If setting or modifying annotations, a value must be provided. If setting or modifying annotations, a value must be provided.
required: false required: false
version_added: "1.6" version_added: "1.6"
pkgsite: pkgsite:
description: description:
- for pkgng versions before 1.1.4, specify packagesite to use - For pkgng versions before 1.1.4, specify packagesite to use
for downloading packages, if not specified, use settings from for downloading packages. If not specified, use settings from
/usr/local/etc/pkg.conf C(/usr/local/etc/pkg.conf).
for newer pkgng versions, specify a the name of a repository - For newer pkgng versions, specify a the name of a repository
configured in /usr/local/etc/pkg/repos configured in C(/usr/local/etc/pkg/repos).
required: false required: false
rootdir: rootdir:
description: description:
- for pkgng versions 1.5 and later, pkg will install all packages - For pkgng versions 1.5 and later, pkg will install all packages
within the specified root directory within the specified root directory.
- can not be used together with 'chroot' option - Can not be used together with I(chroot) option.
required: false required: false
chroot: chroot:
version_added: "2.1" version_added: "2.1"
description: description:
- pkg will chroot in the specified environment - Pkg will chroot in the specified environment.
- can not be used together with 'rootdir' option - Can not be used together with I(rootdir) option.
required: false required: false
autoremove: autoremove:
version_added: "2.2" version_added: "2.2"
description: description:
- remove automatically installed packages which are no longer needed - Remove automatically installed packages which are no longer needed.
required: false required: false
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
default: no default: no