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

Avoid having module documentation links to itself (#21329)

Browse source 
* Avoid having module documentation links to itself

A lot of modules use M(own_module) in their documentation causing a link
in the documentation to itself.

* Make note more clear now
This commit is contained in:
Dag Wieers 2017-02-13 15:02:34 +01:00 • committed by John R Barker
parent fb32c19fea
commit f824b2ce8d
32 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/modules/commands/command.py
View file

@ -29,7 +29,7 @@ module: command
short_description: Executes a command on a remote node
version_added: historical
description:
- The M(command) module takes the command name followed by a list of space-delimited arguments.
- The C(command) module takes the command name followed by a list of space-delimited arguments.
- The given command will be executed on all selected nodes. It will not be
processed through the shell, so variables like C($HOME) and operations
like C("<"), C(">"), C("|"), C(";") and C("&") will not work (use the M(shell)
@ -72,7 +72,7 @@ options:
required: false
notes:
- If you want to run a command through the shell (say you are using C(<), C(>), C(|), etc), you actually want the M(shell) module instead.
The M(command) module is much more secure as it's not affected by the user's environment.
The C(command) module is much more secure as it's not affected by the user's environment.
- " C(creates), C(removes), and C(chdir) can be specified after the command.
For instance, if you only want to run a command if a certain file does not exist, use this."
author: