mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-21 09:51:27 -07:00
[pi ... prof]*: normalize docs (#9371)
* [pi ... prof]*: normalize docs * Update plugins/modules/pkg5_publisher.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky
GitHub
parent
23d97fa4b0
commit
13e2097f37
23 changed files with 702 additions and 766 deletions
|
|
@ -14,107 +14,100 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: pkgng
|
||||
short_description: Package manager for FreeBSD >= 9.0
|
||||
description:
|
||||
- Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0.
|
||||
- Manage binary packages for FreeBSD using C(pkgng) which is available in versions after 9.0.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name or list of names of packages to install/remove.
|
||||
- "With O(name=*), O(state=latest) will operate, but O(state=present) and O(state=absent) will be noops."
|
||||
required: true
|
||||
aliases: [pkg]
|
||||
type: list
|
||||
elements: str
|
||||
state:
|
||||
description:
|
||||
- State of the package.
|
||||
choices: [ 'present', 'latest', 'absent' ]
|
||||
required: false
|
||||
default: present
|
||||
type: str
|
||||
cached:
|
||||
description:
|
||||
- Use local package base instead of fetching an updated one.
|
||||
type: bool
|
||||
required: false
|
||||
default: false
|
||||
annotation:
|
||||
description:
|
||||
- A list of keyvalue-pairs of the form
|
||||
C(<+/-/:><key>[=<value>]). A V(+) denotes adding an annotation, a
|
||||
V(-) denotes removing an annotation, and V(:) denotes modifying an
|
||||
annotation.
|
||||
If setting or modifying annotations, a value must be provided.
|
||||
required: false
|
||||
type: list
|
||||
elements: str
|
||||
pkgsite:
|
||||
description:
|
||||
- For pkgng versions before 1.1.4, specify packagesite to use
|
||||
for downloading packages. If not specified, use settings from
|
||||
C(/usr/local/etc/pkg.conf).
|
||||
- For newer pkgng versions, specify a the name of a repository
|
||||
configured in C(/usr/local/etc/pkg/repos).
|
||||
required: false
|
||||
type: str
|
||||
rootdir:
|
||||
description:
|
||||
- For pkgng versions 1.5 and later, pkg will install all packages
|
||||
within the specified root directory.
|
||||
- Can not be used together with O(chroot) or O(jail) options.
|
||||
required: false
|
||||
type: path
|
||||
chroot:
|
||||
description:
|
||||
- Pkg will chroot in the specified environment.
|
||||
- Can not be used together with O(rootdir) or O(jail) options.
|
||||
required: false
|
||||
type: path
|
||||
jail:
|
||||
description:
|
||||
- Pkg will execute in the given jail name or id.
|
||||
- Can not be used together with O(chroot) or O(rootdir) options.
|
||||
type: str
|
||||
autoremove:
|
||||
description:
|
||||
- Remove automatically installed packages which are no longer needed.
|
||||
required: false
|
||||
type: bool
|
||||
default: false
|
||||
ignore_osver:
|
||||
description:
|
||||
- Ignore FreeBSD OS version check, useful on -STABLE and -CURRENT branches.
|
||||
- Defines the E(IGNORE_OSVERSION) environment variable.
|
||||
required: false
|
||||
type: bool
|
||||
default: false
|
||||
version_added: 1.3.0
|
||||
use_globs:
|
||||
description:
|
||||
- Treat the package names as shell glob patterns.
|
||||
required: false
|
||||
type: bool
|
||||
default: true
|
||||
version_added: 9.3.0
|
||||
name:
|
||||
description:
|
||||
- Name or list of names of packages to install/remove.
|
||||
- With O(name=*), O(state=latest) will operate, but O(state=present) and O(state=absent) will be noops.
|
||||
required: true
|
||||
aliases: [pkg]
|
||||
type: list
|
||||
elements: str
|
||||
state:
|
||||
description:
|
||||
- State of the package.
|
||||
choices: ['present', 'latest', 'absent']
|
||||
required: false
|
||||
default: present
|
||||
type: str
|
||||
cached:
|
||||
description:
|
||||
- Use local package base instead of fetching an updated one.
|
||||
type: bool
|
||||
required: false
|
||||
default: false
|
||||
annotation:
|
||||
description:
|
||||
- A list of keyvalue-pairs of the form C(<+/-/:><key>[=<value>]). A V(+) denotes adding an annotation, a V(-) denotes removing an annotation,
|
||||
and V(:) denotes modifying an annotation. If setting or modifying annotations, a value must be provided.
|
||||
required: false
|
||||
type: list
|
||||
elements: str
|
||||
pkgsite:
|
||||
description:
|
||||
- For C(pkgng) versions before 1.1.4, specify C(packagesite) to use for downloading packages.
|
||||
If not specified, use settings from C(/usr/local/etc/pkg.conf).
|
||||
- For newer C(pkgng) versions, specify a the name of a repository configured in C(/usr/local/etc/pkg/repos).
|
||||
required: false
|
||||
type: str
|
||||
rootdir:
|
||||
description:
|
||||
- For C(pkgng) versions 1.5 and later, pkg will install all packages within the specified root directory.
|
||||
- Can not be used together with O(chroot) or O(jail) options.
|
||||
required: false
|
||||
type: path
|
||||
chroot:
|
||||
description:
|
||||
- Pkg will chroot in the specified environment.
|
||||
- Can not be used together with O(rootdir) or O(jail) options.
|
||||
required: false
|
||||
type: path
|
||||
jail:
|
||||
description:
|
||||
- Pkg will execute in the given jail name or id.
|
||||
- Can not be used together with O(chroot) or O(rootdir) options.
|
||||
type: str
|
||||
autoremove:
|
||||
description:
|
||||
- Remove automatically installed packages which are no longer needed.
|
||||
required: false
|
||||
type: bool
|
||||
default: false
|
||||
ignore_osver:
|
||||
description:
|
||||
- Ignore FreeBSD OS version check, useful on C(-STABLE) and C(-CURRENT) branches.
|
||||
- Defines the E(IGNORE_OSVERSION) environment variable.
|
||||
required: false
|
||||
type: bool
|
||||
default: false
|
||||
version_added: 1.3.0
|
||||
use_globs:
|
||||
description:
|
||||
- Treat the package names as shell glob patterns.
|
||||
required: false
|
||||
type: bool
|
||||
default: true
|
||||
version_added: 9.3.0
|
||||
author: "bleader (@bleader)"
|
||||
notes:
|
||||
- When using pkgsite, be careful that already in cache packages won't be downloaded again.
|
||||
- When used with a C(loop:) each package will be processed individually,
|
||||
it is much more efficient to pass the list directly to the O(name) option.
|
||||
'''
|
||||
- When using pkgsite, be careful that already in cache packages will not be downloaded again.
|
||||
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name)
|
||||
option.
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Install package foo
|
||||
community.general.pkgng:
|
||||
name: foo
|
||||
|
|
@ -149,7 +142,7 @@ EXAMPLES = '''
|
|||
name: foo/bar
|
||||
state: latest
|
||||
use_globs: false
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
from collections import defaultdict
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue