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

s[o-y]*: normalize docs (#9351)

Browse source 
* s[o-y]*: normalize docs

* Apply suggestions from code review

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

* Update plugins/modules/spectrum_model_attrs.py

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-25 21:48:22 +13:00 • committed by GitHub
parent 6cd3f79e19
commit 4b23e5ecff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
20 changed files with 994 additions and 1174 deletions
Download patch file Download diff file Expand all files Collapse all files

34
plugins/modules/swupd.py
View file

@ -10,13 +10,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: swupd
short_description: Manages updates and bundles in ClearLinux systems
description:
- Manages updates and bundles with the swupd bundle manager, which is used by the
Clear Linux Project for Intel Architecture.
- Manages updates and bundles with the swupd bundle manager, which is used by the Clear Linux Project for Intel Architecture.
author: Alberto Murillo (@albertomurillo)
extends_documentation_fragment:
- community.general.attributes
@ -28,19 +26,16 @@ attributes:
options:
contenturl:
description:
- URL pointing to the contents of available bundles.
If not specified, the contents are retrieved from clearlinux.org.
- URL pointing to the contents of available bundles. If not specified, the contents are retrieved from clearlinux.org.
type: str
format:
description:
- The format suffix for version file downloads. For example [1,2,3,staging,etc].
If not specified, the default format is used.
- The format suffix for version file downloads. For example [1,2,3,staging,etc]. If not specified, the default format is used.
type: str
manifest:
description:
- The manifest contains information about the bundles at certain version of the OS.
Specify a Manifest version to verify against that version or leave unspecified to
verify against the current version.
- The manifest contains information about the bundles at certain version of the OS. Specify a Manifest version to verify against that version
or leave unspecified to verify against the current version.
aliases: [release, version]
type: int
name:
@ -50,8 +45,7 @@ options:
type: str
state:
description:
- Indicates the desired (I)bundle state. V(present) ensures the bundle
is installed while V(absent) ensures the (I)bundle is not installed.
- Indicates the desired (I)bundle state. V(present) ensures the bundle is installed while V(absent) ensures the (I)bundle is not installed.
default: present
choices: [present, absent]
type: str
@ -73,9 +67,9 @@ options:
description:
- URL for version string download.
type: str
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Update the OS to the latest version
community.general.swupd:
update: true
@ -98,18 +92,18 @@ EXAMPLES = '''
community.general.swupd:
verify: true
manifest: 12920
'''
"""
RETURN = '''
RETURN = r"""
stdout:
description: stdout of swupd
description: C(stdout) of C(swupd).
returned: always
type: str
stderr:
description: stderr of swupd
description: C(stderr) of C(swupd).
returned: always
type: str
'''
"""
import os
from ansible.module_utils.basic import AnsibleModule