ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Document argument types for flatpak and flatpak_remote (#270)

Browse source
This commit is contained in:
Jon Dufresne 2020-05-04 07:42:15 -07:00 committed by GitHub
parent a85b169a0e
commit 385d03a629
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
plugins/modules/packaging/os/flatpak.py
View file

@ -51,12 +51,14 @@ options:
description: description:
- The path to the C(flatpak) executable to use. - The path to the C(flatpak) executable to use.
- By default, this module looks for the C(flatpak) executable on the path. - By default, this module looks for the C(flatpak) executable on the path.
type: path
default: flatpak default: flatpak
method: method:
description: description:
- The installation method to use. - The installation method to use.
- Defines if the I(flatpak) is supposed to be installed globally for the whole C(system) - Defines if the I(flatpak) is supposed to be installed globally for the whole C(system)
or only for the current C(user). or only for the current C(user).
type: str
choices: [ system, user ] choices: [ system, user ]
default: system default: system
name: name:
@ -72,6 +74,7 @@ options:
installed flatpak based on the name of the flatpakref to remove it. However, there is no 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 guarantee that the names of the flatpakref file and the reverse DNS name of the installed
flatpak do match. flatpak do match.
type: str
required: true required: true
remote: remote:
description: description:
@ -79,11 +82,13 @@ options:
- By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before - By default, C(flathub) is assumed, but you do need to add the flathub flatpak_remote before
you can use this. you can use this.
- See the M(flatpak_remote) module for managing flatpak remotes. - See the M(flatpak_remote) module for managing flatpak remotes.
type: str
default: flathub default: flathub
state: state:
description: description:
- Indicates the desired package state. - Indicates the desired package state.
choices: [ absent, present ] choices: [ absent, present ]
type: str
default: present default: present
''' '''

5
plugins/modules/packaging/os/flatpak_remote.py
View file

@ -55,6 +55,7 @@ options:
description: description:
- The path to the C(flatpak) executable to use. - The path to the C(flatpak) executable to use.
- By default, this module looks for the C(flatpak) executable on the path. - By default, this module looks for the C(flatpak) executable on the path.
type: str
default: flatpak default: flatpak
flatpakrepo_url: flatpakrepo_url:
description: description:
@ -63,11 +64,13 @@ options:
is added using the specified installation C(method). is added using the specified installation C(method).
- When used with I(state=absent), this is not required. - When used with I(state=absent), this is not required.
- Required when I(state=present). - Required when I(state=present).
type: str
method: method:
description: description:
- The installation method to use. - The installation method to use.
- Defines if the I(flatpak) is supposed to be installed globally for the whole C(system) - Defines if the I(flatpak) is supposed to be installed globally for the whole C(system)
or only for the current C(user). or only for the current C(user).
type: str
choices: [ system, user ] choices: [ system, user ]
default: system default: system
name: name:
@ -76,10 +79,12 @@ options:
- When used with I(state=present), the remote will be added to the managed host under - When used with I(state=present), the remote will be added to the managed host under
the specified I(name). the specified I(name).
- When used with I(state=absent) the remote with that name will be removed. - When used with I(state=absent) the remote with that name will be removed.
type: str
required: true required: true
state: state:
description: description:
- Indicates the desired package state. - Indicates the desired package state.
type: str
choices: [ absent, present ] choices: [ absent, present ]
default: present default: present
''' '''

2
tests/sanity/ignore-2.10.txt
View file

@ -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-invalid
plugins/modules/packaging/os/apt_rpm.py validate-modules:parameter-type-not-in-doc 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/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.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/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.py validate-modules:parameter-invalid
plugins/modules/packaging/os/homebrew_cask.py validate-modules:parameter-invalid plugins/modules/packaging/os/homebrew_cask.py validate-modules:parameter-invalid