ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-22 18:31:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Use semantic markup (modules a-c) (#6671)

Browse source 
* Use semantic markup.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:46:33 +02:00 • committed by GitHub
parent 7ae8cc9902
commit 6fc1df9b83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 193 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

32
plugins/modules/cpanm.py
View file

@ -27,8 +27,8 @@ options:
name:
type: str
description:
- The Perl library to install. Valid values change according to the I(mode), see notes for more details.
- Note that for installing from a local path the parameter I(from_path) should be used.
- The Perl library to install. Valid values change according to the O(mode), see notes for more details.
- Note that for installing from a local path the parameter O(from_path) should be used.
aliases: [pkg]
from_path:
type: path
@ -59,7 +59,7 @@ options:
default: false
version:
description:
- Version specification for the perl module. When I(mode) is C(new), C(cpanm) version operators are accepted.
- Version specification for the perl module. When O(mode) is V(new), C(cpanm) version operators are accepted.
type: str
executable:
description:
@ -68,32 +68,24 @@ options:
mode:
description:
- Controls the module behavior. See notes below for more details.
- Default is C(compatibility) but that behavior is deprecated and will be changed to C(new) in community.general 9.0.0.
- Default is V(compatibility) but that behavior is deprecated and will be changed to V(new) in community.general 9.0.0.
type: str
choices: [compatibility, new]
version_added: 3.0.0
name_check:
description:
- When in C(new) mode, this parameter can be used to check if there is a module I(name) installed (at I(version), when specified).
- When O(mode=new), this parameter can be used to check if there is a module O(name) installed (at O(version), when specified).
type: str
version_added: 3.0.0
notes:
- Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host.
- "This module now comes with a choice of execution I(mode): C(compatibility) or C(new)."
- "C(compatibility) mode:"
- When using C(compatibility) mode, the module will keep backward compatibility. This is the default mode.
- I(name) must be either a module name or a distribution file.
- >
If the perl module given by I(name) is installed (at the exact I(version) when specified), then nothing happens.
Otherwise, it will be installed using the C(cpanm) executable.
- I(name) cannot be an URL, or a git URL.
- C(cpanm) version specifiers do not work in this mode.
- "C(new) mode:"
- "When using C(new) mode, the module will behave differently"
- >
The I(name) parameter may refer to a module name, a distribution file,
a HTTP URL or a git repository URL as described in C(cpanminus) documentation.
- C(cpanm) version specifiers are recognized.
- "This module now comes with a choice of execution O(mode): V(compatibility) or V(new)."
- "O(mode=compatibility): When using V(compatibility) mode, the module will keep backward compatibility. This is the default mode.
O(name) must be either a module name or a distribution file. If the perl module given by O(name) is installed (at the exact O(version)
when specified), then nothing happens. Otherwise, it will be installed using the C(cpanm) executable. O(name) cannot be an URL, or a git URL.
C(cpanm) version specifiers do not work in this mode."
- "O(mode=new): When using V(new) mode, the module will behave differently. The O(name) parameter may refer to a module name, a distribution file,
a HTTP URL or a git repository URL as described in C(cpanminus) documentation. C(cpanm) version specifiers are recognized."
author:
- "Franck Cuny (@fcuny)"
- "Alexei Znamensky (@russoz)"