mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Document argument types for flatpak and flatpak_remote (#270)
This commit is contained in:
parent
a85b169a0e
commit
385d03a629
3 changed files with 10 additions and 2 deletions
|
@ -51,12 +51,14 @@ options:
|
|||
description:
|
||||
- The path to the C(flatpak) executable to use.
|
||||
- By default, this module looks for the C(flatpak) executable on the path.
|
||||
type: path
|
||||
default: flatpak
|
||||
method:
|
||||
description:
|
||||
- The installation method to use.
|
||||
- Defines if the I(flatpak) is supposed to be installed globally for the whole C(system)
|
||||
or only for the current C(user).
|
||||
type: str
|
||||
choices: [ system, user ]
|
||||
default: system
|
||||
name:
|
||||
|
@ -72,6 +74,7 @@ options:
|
|||
installed flatpak based on the name of the flatpakref to remove it. However, there is no
|
||||
guarantee that the names of the flatpakref file and the reverse DNS name of the installed
|
||||
flatpak do match.
|
||||
type: str
|
||||
required: true
|
||||
remote:
|
||||
description:
|
||||
|
@ -79,11 +82,13 @@ options:
|
|||
- By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before
|
||||
you can use this.
|
||||
- See the M(flatpak_remote) module for managing flatpak remotes.
|
||||
type: str
|
||||
default: flathub
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired package state.
|
||||
choices: [ absent, present ]
|
||||
type: str
|
||||
default: present
|
||||
'''
|
||||
|
||||
|
|
|
@ -55,6 +55,7 @@ options:
|
|||
description:
|
||||
- The path to the C(flatpak) executable to use.
|
||||
- By default, this module looks for the C(flatpak) executable on the path.
|
||||
type: str
|
||||
default: flatpak
|
||||
flatpakrepo_url:
|
||||
description:
|
||||
|
@ -63,11 +64,13 @@ options:
|
|||
is added using the specified installation C(method).
|
||||
- When used with I(state=absent), this is not required.
|
||||
- Required when I(state=present).
|
||||
type: str
|
||||
method:
|
||||
description:
|
||||
- The installation method to use.
|
||||
- Defines if the I(flatpak) is supposed to be installed globally for the whole C(system)
|
||||
or only for the current C(user).
|
||||
type: str
|
||||
choices: [ system, user ]
|
||||
default: system
|
||||
name:
|
||||
|
@ -76,10 +79,12 @@ options:
|
|||
- When used with I(state=present), the remote will be added to the managed host under
|
||||
the specified I(name).
|
||||
- When used with I(state=absent) the remote with that name will be removed.
|
||||
type: str
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired package state.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
'''
|
||||
|
|
|
@ -1264,9 +1264,7 @@ plugins/modules/packaging/os/apt_rpm.py validate-modules:doc-default-does-not-ma
|
|||
plugins/modules/packaging/os/apt_rpm.py validate-modules:parameter-invalid
|
||||
plugins/modules/packaging/os/apt_rpm.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/packaging/os/apt_rpm.py validate-modules:undocumented-parameter
|
||||
plugins/modules/packaging/os/flatpak.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/packaging/os/flatpak.py validate-modules:use-run-command-not-popen
|
||||
plugins/modules/packaging/os/flatpak_remote.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/packaging/os/flatpak_remote.py validate-modules:use-run-command-not-popen
|
||||
plugins/modules/packaging/os/homebrew.py validate-modules:parameter-invalid
|
||||
plugins/modules/packaging/os/homebrew_cask.py validate-modules:parameter-invalid
|
||||
|
|
Loading…
Reference in a new issue