Command module docs: args vs argv #49907
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ansibot
added
affects_2.8
ansibot
added
needs_ci
|
The test |
ansibot
added
needs_revision
ansibot
added
core_review
bcoca
reviewed
Dec 15, 2018
| args: | ||
| chdir: somedir/ | ||
| creates: /path/to/database | ||
|
|
||
| - name: use argv to send the command as a list. Be sure to leave command empty | ||
| - name: Use 'argv' with 'args' to send a command as a list - be sure to leave 'command' empty |
There was a problem hiding this comment.
actually a better way would be command: argv=['echo', 'testing']
There was a problem hiding this comment.
or even
command:
argv:
- echo
- testing
bringing args into the mix is just confusing
There was a problem hiding this comment.
you cannot pass 2 commands to command, argv is not for that, it is to pass the command and the arguments to the command
There was a problem hiding this comment.
echo 'testing' == argv: ['echo', 'testing']
There was a problem hiding this comment.
Ah, glad I asked. What is the advantage of using argv over just passing them directly to command then?
There was a problem hiding this comment.
take 3 . . . how's 6fe81cd look?
There was a problem hiding this comment.
better, there are more cases than just whitespace, but that should be good enough
ansibot
removed
the
needs_triage
samccann
reviewed
Dec 19, 2018
Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
kbreit
pushed a commit
to kbreit/ansible
that referenced
this pull request
Jan 11, 2019
* add note about 'args', update examples * Update lib/ansible/modules/commands/command.py Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Per user feedback, adds information to the
commandmodule documentation about the difference between theargvparameter and theargstask keyword. Also updates and expands examples.ISSUE TYPE
COMPONENT NAME
docs.ansible.com