[doc] command module: mention all parameter types (#56396)

This commit is contained in:
Pilou 2019-05-14 13:50:50 +00:00 committed by Alicia Cozine
parent 30ccc8e1bd
commit 8968d41599

View file

@ -36,6 +36,7 @@ options:
- See the examples on how to use this module. - See the examples on how to use this module.
required: yes required: yes
argv: argv:
type: list
description: description:
- Passes the command as a list rather than a string. - Passes the command as a list rather than a string.
- Use C(argv) to avoid quoting values that would otherwise be interpreted incorrectly (for example "user name"). - Use C(argv) to avoid quoting values that would otherwise be interpreted incorrectly (for example "user name").
@ -43,13 +44,16 @@ options:
provided, not both. One or the other must be provided. provided, not both. One or the other must be provided.
version_added: "2.6" version_added: "2.6"
creates: creates:
type: path
description: description:
- A filename or (since 2.0) glob pattern. If it already exists, this step B(won't) be run. - A filename or (since 2.0) glob pattern. If it already exists, this step B(won't) be run.
removes: removes:
type: path
description: description:
- A filename or (since 2.0) glob pattern. If it already exists, this step B(will) be run. - A filename or (since 2.0) glob pattern. If it already exists, this step B(will) be run.
version_added: "0.8" version_added: "0.8"
chdir: chdir:
type: path
description: description:
- Change into this directory before running the command. - Change into this directory before running the command.
version_added: "0.6" version_added: "0.6"