mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 10:21:25 -07:00
l*.py: normalize docs (#9390)
This commit is contained in:
parent
6b7ea3443d
commit
cea6eeef37
25 changed files with 1194 additions and 1350 deletions
|
@ -10,14 +10,13 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: layman
|
||||
author: "Jakub Jirutka (@jirutka)"
|
||||
short_description: Manage Gentoo overlays
|
||||
description:
|
||||
- Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux.
|
||||
Please note that Layman must be installed on a managed node prior using this module.
|
||||
- Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed
|
||||
on a managed node prior using this module.
|
||||
requirements:
|
||||
- layman python module
|
||||
extends_documentation_fragment:
|
||||
|
@ -30,15 +29,13 @@ attributes:
|
|||
options:
|
||||
name:
|
||||
description:
|
||||
- The overlay id to install, synchronize, or uninstall.
|
||||
Use 'ALL' to sync all of the installed overlays (can be used only when O(state=updated)).
|
||||
- The overlay id to install, synchronize, or uninstall. Use V(ALL) to sync all of the installed overlays (can be used only when O(state=updated)).
|
||||
required: true
|
||||
type: str
|
||||
list_url:
|
||||
description:
|
||||
- An URL of the alternative overlays list that defines the overlay to install.
|
||||
This list will be fetched and saved under C(${overlay_defs}/${name}.xml), where
|
||||
C(overlay_defs) is read from the Layman's configuration.
|
||||
- An URL of the alternative overlays list that defines the overlay to install. This list will be fetched and saved under C(${overlay_defs}/${name}.xml),
|
||||
where C(overlay_defs) is read from the Layman's configuration.
|
||||
aliases: [url]
|
||||
type: str
|
||||
state:
|
||||
|
@ -49,14 +46,13 @@ options:
|
|||
type: str
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated. This should only be
|
||||
set to V(false) when no other option exists. Prior to 1.9.3 the code
|
||||
defaulted to V(false).
|
||||
- If V(false), SSL certificates will not be validated. This should only be set to V(false) when no other option exists. Prior to 1.9.3 the
|
||||
code defaulted to V(false).
|
||||
type: bool
|
||||
default: true
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Install the overlay mozilla which is on the central overlays list
|
||||
community.general.layman:
|
||||
name: mozilla
|
||||
|
@ -81,7 +77,7 @@ EXAMPLES = '''
|
|||
community.general.layman:
|
||||
name: cvut
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
import shutil
|
||||
import traceback
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue