r*: normalize docs (#9354)

* r*: normalize docs

* Apply suggestions from code review

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

* Apply suggestions from code review

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-26 09:19:49 +13:00 committed by GitHub
parent 70b62ed745
commit 9751461295
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
22 changed files with 1858 additions and 1947 deletions

View file

@ -10,50 +10,49 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: rpm_ostree_pkg
short_description: Install or uninstall overlay additional packages
version_added: "2.0.0"
description:
- Install or uninstall overlay additional packages using C(rpm-ostree) command.
- Install or uninstall overlay additional packages using C(rpm-ostree) command.
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:
description:
- Name of overlay package to install or remove.
required: true
type: list
elements: str
aliases: [ pkg ]
state:
description:
required: true
type: list
elements: str
aliases: [pkg]
state:
description:
- State of the overlay package.
- V(present) simply ensures that a desired package is installed.
- V(absent) removes the specified package.
choices: [ 'absent', 'present' ]
default: 'present'
type: str
apply_live:
description:
choices: ['absent', 'present']
default: 'present'
type: str
apply_live:
description:
- Adds the options C(--apply-live) when O(state=present).
- Option is ignored when O(state=absent).
- For more information, please see U(https://coreos.github.io/rpm-ostree/apply-live/).
type: bool
default: false
version_added: 10.1.0
type: bool
default: false
version_added: 10.1.0
author:
- Dusty Mabe (@dustymabe)
- Abhijeet Kasurde (@Akasurde)
'''
- Dusty Mabe (@dustymabe)
- Abhijeet Kasurde (@Akasurde)
"""
EXAMPLES = r'''
EXAMPLES = r"""
- name: Install overlay package
community.general.rpm_ostree_pkg:
name: nfs-utils
@ -80,51 +79,51 @@ EXAMPLES = r'''
until: rpm_ostree_pkg is not failed
retries: 10
dealy: 30
'''
"""
RETURN = r'''
RETURN = r"""
rc:
description: Return code of rpm-ostree command.
returned: always
type: int
sample: 0
description: Return code of rpm-ostree command.
returned: always
type: int
sample: 0
changed:
description: State changes.
returned: always
type: bool
sample: true
description: State changes.
returned: always
type: bool
sample: true
action:
description: Action performed.
returned: always
type: str
sample: 'install'
description: Action performed.
returned: always
type: str
sample: 'install'
packages:
description: A list of packages specified.
returned: always
type: list
sample: ['nfs-utils']
description: A list of packages specified.
returned: always
type: list
sample: ['nfs-utils']
stdout:
description: Stdout of rpm-ostree command.
returned: always
type: str
sample: 'Staging deployment...done\n...'
description: Stdout of rpm-ostree command.
returned: always
type: str
sample: 'Staging deployment...done\n...'
stderr:
description: Stderr of rpm-ostree command.
returned: always
type: str
sample: ''
description: Stderr of rpm-ostree command.
returned: always
type: str
sample: ''
cmd:
description: Full command used for performed action.
returned: always
type: str
sample: 'rpm-ostree uninstall --allow-inactive --idempotent --unchanged-exit-77 nfs-utils'
description: Full command used for performed action.
returned: always
type: str
sample: 'rpm-ostree uninstall --allow-inactive --idempotent --unchanged-exit-77 nfs-utils'
needs_reboot:
description: Determine if machine needs a reboot to apply current changes.
returned: success
type: bool
sample: true
version_added: 10.1.0
'''
description: Determine if machine needs a reboot to apply current changes.
returned: success
type: bool
sample: true
version_added: 10.1.0
"""
from ansible.module_utils.basic import AnsibleModule