ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-04 15:29:10 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

[ab]*.py: normalize docs (#9421)

Browse source 
* [ab]*.py: normalize docs

* Update plugins/modules/atomic_image.py

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-28 02:29:15 +13:00 • committed by GitHub
parent 43599c6850
commit 2a2a9661d9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1931 additions and 2013 deletions
Download patch file Download diff file Expand all files Collapse all files

33
plugins/modules/apt_rpm.py
View file

@ -11,8 +11,7 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: apt_rpm
short_description: APT-RPM package manager
description:
@ -28,18 +27,16 @@ options:
package:
description:
- List of packages to install, upgrade, or remove.
- Since community.general 8.0.0, may include paths to local C(.rpm) files
if O(state=installed) or O(state=present), requires C(rpm) python
module.
aliases: [ name, pkg ]
- Since community.general 8.0.0, may include paths to local C(.rpm) files if O(state=installed) or O(state=present),
requires C(rpm) Python module.
aliases: [name, pkg]
type: list
elements: str
state:
description:
- Indicates the desired package state.
- Please note that V(present) and V(installed) are equivalent to V(latest) right now.
This will change in the future. To simply ensure that a package is installed, without upgrading
it, use the V(present_not_latest) state.
- Please note that V(present) and V(installed) are equivalent to V(latest) right now. This will change in the future.
To simply ensure that a package is installed, without upgrading it, use the V(present_not_latest) state.
- The states V(latest) and V(present_not_latest) have been added in community.general 8.6.0.
choices:
- absent
@ -52,14 +49,15 @@ options:
type: str
update_cache:
description:
- Run the equivalent of C(apt-get update) before the operation. Can be run as part of the package installation or as a separate step.
- Run the equivalent of C(apt-get update) before the operation. Can be run as part of the package installation or as
a separate step.
- Default is not to update the cache.
type: bool
default: false
clean:
description:
- Run the equivalent of C(apt-get clean) to clear out the local repository of retrieved package files. It removes everything but
the lock file from C(/var/cache/apt/archives/) and C(/var/cache/apt/archives/partial/).
- Run the equivalent of C(apt-get clean) to clear out the local repository of retrieved package files. It removes everything
but the lock file from C(/var/cache/apt/archives/) and C(/var/cache/apt/archives/partial/).
- Can be run as part of the package installation (clean runs before install) or as a separate step.
type: bool
default: false
@ -77,13 +75,12 @@ options:
default: false
version_added: 6.5.0
requirements:
- C(rpm) python package (rpm bindings), optional. Required if O(package)
option includes local files.
- C(rpm) Python package (rpm bindings), optional. Required if O(package) option includes local files.
author:
- Evgenii Terechkov (@evgkrsk)
'''
- Evgenii Terechkov (@evgkrsk)
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Install package foo
community.general.apt_rpm:
pkg: foo
@ -122,7 +119,7 @@ EXAMPLES = '''
update_cache: true
dist_upgrade: true
update_kernel: true
'''
"""
import os
import re