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.

Sign up for GitHub

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

Jump to bottom

Remove "mode: preserve" option from documentation #71486

Merged
merged 1 commit into from Aug 27, 2020
Merged

Remove "mode: preserve" option from documentation #71486

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions lib/ansible/plugins/doc_fragments/files.py
View file
Open in desktop
Expand Up @@ -25,8 +25,6 @@ class ModuleDocFragment(object):
number which will have unexpected results.
- As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or
C(u=rw,g=r,o=r)).
- As of Ansible 2.6, the mode may also be the special string C(preserve).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do this, please add a first line item that mentions that the implicit behavior is to preserve file permissions, at this moment this is not written anywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that the case for all modules that include this documentation? I'm not so sure about the unarchive module for instance, however I might be wrong.
I'm very careful to make such assumptions - especially seeing as similar assumptions led to problems that were resolved by this PR 😄.

If you're 100% sure that this is indeed the case for all of those modules, I'd be happy to follow up with another PR. Otherwise I'd leave it up to the maintainers of those modules individually, as they might need more specific/detailed information.

- When set to C(preserve) the file will be given the same permissions as the source file.
type: raw
owner:
description:
Expand Down