ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-19 11:20:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

[PR #9373/d96e5604 backport][stable-10] [onev ... ovh]*.py: normalize docs (#9381)

Browse source 
[onev ... ovh]*.py: normalize docs (#9373)

* [onev ... ovh]*.py: normalize docs

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d96e56048f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 22:56:20 +01:00 • committed by GitHub
commit e38f9e5cfc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 956 additions and 1021 deletions
Download patch file Download diff file Expand all files Collapse all files

113
plugins/modules/opkg.py
View file

@ -11,71 +11,68 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: opkg
author: "Patrick Pelletier (@skinp)"
short_description: Package manager for OpenWrt and Openembedded/Yocto based Linux distributions
description:
- Manages ipk packages for OpenWrt and Openembedded/Yocto based Linux distributions
- Manages ipk packages for OpenWrt and Openembedded/Yocto based Linux distributions.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
check_mode:
support: none
diff_mode:
support: none
options:
name:
description:
- Name of package(s) to install/remove.
- C(NAME=VERSION) syntax is also supported to install a package
in a certain version. See the examples. This only works on Yocto based
Linux distributions (opkg>=0.3.2) and not for OpenWrt. This is
supported since community.general 6.2.0.
aliases: [pkg]
required: true
type: list
elements: str
state:
description:
- State of the package.
choices: [ 'present', 'absent', 'installed', 'removed' ]
default: present
type: str
force:
description:
- The C(opkg --force) parameter used.
- State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain the same behavior.
choices:
- ""
- "depends"
- "maintainer"
- "reinstall"
- "overwrite"
- "downgrade"
- "space"
- "postinstall"
- "remove"
- "checksum"
- "removal-of-dependent-packages"
type: str
update_cache:
description:
- Update the package DB first.
default: false
type: bool
executable:
description:
- The executable location for C(opkg).
type: path
version_added: 7.2.0
name:
description:
- Name of package(s) to install/remove.
- C(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works on Yocto based Linux
distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0.
aliases: [pkg]
required: true
type: list
elements: str
state:
description:
- State of the package.
choices: ['present', 'absent', 'installed', 'removed']
default: present
type: str
force:
description:
- The C(opkg --force) parameter used.
- State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain the same behavior.
choices:
- ""
- "depends"
- "maintainer"
- "reinstall"
- "overwrite"
- "downgrade"
- "space"
- "postinstall"
- "remove"
- "checksum"
- "removal-of-dependent-packages"
type: str
update_cache:
description:
- Update the package DB first.
default: false
type: bool
executable:
description:
- The executable location for C(opkg).
type: path
version_added: 7.2.0
requirements:
- opkg
- python
'''
- opkg
- python
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Install foo
community.general.opkg:
name: foo
@ -109,9 +106,9 @@ EXAMPLES = '''
name: foo
state: present
force: overwrite
'''
"""
RETURN = """
RETURN = r"""
version:
description: Version of opkg.
type: str