mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-29 11:40:22 -07:00
[PR #9308/f9bfe4e4 backport][stable-10] x*: adjust docs (#9342)
x*: adjust docs (#9308)
* adjust docs
* Update plugins/modules/xml.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* fix capitalisation
* add markup to references of the xe command (xenserver)
* add missing markup
* Update plugins/modules/xml.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit f9bfe4e4a6)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
434032080e
commit
474c7a7240
11 changed files with 827 additions and 863 deletions
|
|
@ -7,18 +7,17 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: xfconf_info
|
||||
author:
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
short_description: Retrieve XFCE4 configurations
|
||||
version_added: 3.5.0
|
||||
description:
|
||||
- This module allows retrieving Xfce 4 configurations with the help of C(xfconf-query).
|
||||
- This module allows retrieving Xfce 4 configurations with the help of C(xfconf-query).
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
attributes:
|
||||
check_mode:
|
||||
version_added: 3.3.0
|
||||
|
|
@ -26,26 +25,21 @@ attributes:
|
|||
options:
|
||||
channel:
|
||||
description:
|
||||
- >
|
||||
A Xfconf preference channel is a top-level tree key, inside of the
|
||||
Xfconf repository that corresponds to the location for which all
|
||||
application properties/keys are stored.
|
||||
- If not provided, the module will list all available channels.
|
||||
- "A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location for which all application
|
||||
properties/keys are stored."
|
||||
- If not provided, the module will list all available channels.
|
||||
type: str
|
||||
property:
|
||||
description:
|
||||
- >
|
||||
A Xfce preference key is an element in the Xfconf repository
|
||||
that corresponds to an application preference.
|
||||
- If provided, then O(channel) is required.
|
||||
- If not provided and a O(channel) is provided, then the module will list all available properties in that O(channel).
|
||||
- "A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference."
|
||||
- If provided, then O(channel) is required.
|
||||
- If not provided and a O(channel) is provided, then the module will list all available properties in that O(channel).
|
||||
type: str
|
||||
notes:
|
||||
- See man xfconf-query(1) for more details.
|
||||
- See man xfconf-query(1) for more details.
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
---
|
||||
EXAMPLES = r"""
|
||||
- name: Get list of all available channels
|
||||
community.general.xfconf_info: {}
|
||||
register: result
|
||||
|
|
@ -68,63 +62,62 @@ EXAMPLES = """
|
|||
register: result
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
---
|
||||
RETURN = r"""
|
||||
channels:
|
||||
description:
|
||||
- List of available channels.
|
||||
- Returned when the module receives no parameter at all.
|
||||
- List of available channels.
|
||||
- Returned when the module receives no parameter at all.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample:
|
||||
- xfce4-desktop
|
||||
- displays
|
||||
- xsettings
|
||||
- xfwm4
|
||||
- xfce4-desktop
|
||||
- displays
|
||||
- xsettings
|
||||
- xfwm4
|
||||
properties:
|
||||
description:
|
||||
- List of available properties for a specific channel.
|
||||
- Returned by passing only the O(channel) parameter to the module.
|
||||
- List of available properties for a specific channel.
|
||||
- Returned by passing only the O(channel) parameter to the module.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample:
|
||||
- /Gdk/WindowScalingFactor
|
||||
- /Gtk/ButtonImages
|
||||
- /Gtk/CursorThemeSize
|
||||
- /Gtk/DecorationLayout
|
||||
- /Gtk/FontName
|
||||
- /Gtk/MenuImages
|
||||
- /Gtk/MonospaceFontName
|
||||
- /Net/DoubleClickTime
|
||||
- /Net/IconThemeName
|
||||
- /Net/ThemeName
|
||||
- /Xft/Antialias
|
||||
- /Xft/Hinting
|
||||
- /Xft/HintStyle
|
||||
- /Xft/RGBA
|
||||
- /Gdk/WindowScalingFactor
|
||||
- /Gtk/ButtonImages
|
||||
- /Gtk/CursorThemeSize
|
||||
- /Gtk/DecorationLayout
|
||||
- /Gtk/FontName
|
||||
- /Gtk/MenuImages
|
||||
- /Gtk/MonospaceFontName
|
||||
- /Net/DoubleClickTime
|
||||
- /Net/IconThemeName
|
||||
- /Net/ThemeName
|
||||
- /Xft/Antialias
|
||||
- /Xft/Hinting
|
||||
- /Xft/HintStyle
|
||||
- /Xft/RGBA
|
||||
is_array:
|
||||
description:
|
||||
- Flag indicating whether the property is an array or not.
|
||||
- Flag indicating whether the property is an array or not.
|
||||
returned: success
|
||||
type: bool
|
||||
value:
|
||||
description:
|
||||
- The value of the property. Empty if the property is of array type.
|
||||
- The value of the property. Empty if the property is of array type.
|
||||
returned: success
|
||||
type: str
|
||||
sample: Monospace 10
|
||||
value_array:
|
||||
description:
|
||||
- The array value of the property. Empty if the property is not of array type.
|
||||
- The array value of the property. Empty if the property is not of array type.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample:
|
||||
- Main
|
||||
- Work
|
||||
- Tmp
|
||||
- Main
|
||||
- Work
|
||||
- Tmp
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue