Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"file" docs reference non-existent param in other modules #72372

Closed
richlv opened this issue Oct 28, 2020 · 1 comment · Fixed by #73938
Closed

"file" docs reference non-existent param in other modules #72372

richlv opened this issue Oct 28, 2020 · 1 comment · Fixed by #73938
Assignees
Labels
affects_2.11 docs This issue/PR relates to or includes documentation. files Files category module This issue/PR relates to a module. P3 Priority 3 - Approved, No Time Limitation support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@richlv
Copy link
Contributor

richlv commented Oct 28, 2020

SUMMARY

See https://docs.ansible.com/ansible/latest/collections/ansible/builtin/file_module.html, where for the parameter "state" it says:
"see the touch value or the ansible.builtin.copy or ansible.builtin.template module"

Neither
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html#ansible-collections-ansible-builtin-copy-module
nor
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html#ansible-collections-ansible-builtin-template-module
have anything about "touch".

The "file" page also says "Even with other options (i.e mode), the file will be modified but will NOT be created if it does not exist", but a sentence later it describes "touch" value for this same parameter.

Perhaps the "see..." reference should be removed, and the note reworded like this?

"Even with other options (i.e mode), the file will be modified but will NOT be created if it does not exist. Use state touch to have the file created."

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

file

ANSIBLE VERSION

latest

@ansibot
Copy link
Contributor

ansibot commented Oct 28, 2020

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.11 docs This issue/PR relates to or includes documentation. files Files category module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 28, 2020
@bcoca bcoca added P3 Priority 3 - Approved, No Time Limitation and removed needs_triage Needs a first human triage before being processed. labels Oct 29, 2020
@ansible ansible locked and limited conversation to collaborators Apr 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.11 docs This issue/PR relates to or includes documentation. files Files category module This issue/PR relates to a module. P3 Priority 3 - Approved, No Time Limitation support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants