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

Improve docs for umask option of pip module. #49146

Merged
merged 2 commits into from
Nov 27, 2018
Merged

Improve docs for umask option of pip module. #49146

merged 2 commits into from
Nov 27, 2018

Conversation

pillarsdotnet
Copy link
Contributor

@pillarsdotnet pillarsdotnet commented Nov 26, 2018 •
edited

Note that the umask should be specified as an octal string, not an octal (or decimal) integer.

+label: docsite_pr

SUMMARY

Fixes #43256

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

pip

@pillarsdotnet
Improve docs for umask option of pip module.
0521e1c 
Note that the umask should be specified as an octal *string*, not an octal (or decimal) *integer*.

+label: docsite_pr
@pillarsdotnet pillarsdotnet mentioned this pull request Nov 26, 2018
Closed
@ansibot
Copy link
Contributor

ansibot commented Nov 26, 2018

Hi @pillarsdotnet, thank you for submitting this pull-request!

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Nov 26, 2018

cc @Lujeni @mattupstate @webknjaz
click here for bot help

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Nov 26, 2018
@acozine
Copy link
Contributor

acozine commented Nov 26, 2018

Related to #37942 and #37875.

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Nov 26, 2018
webknjaz
webknjaz approved these changes Nov 27, 2018
View reviewed changes
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

@pillarsdotnet thank you!

@acozine acozine merged commit 67a70a1 into ansible:devel Nov 27, 2018
@acozine
Copy link
Contributor

acozine commented Nov 27, 2018

Thanks @pillarsdotnet - can you open a backport PR to stable-2.7 (which is latest on docs.ansible.com)? See https://docs.ansible.com/ansible/devel/community/development_process.html#backport-process.

@pillarsdotnet pillarsdotnet mentioned this pull request Nov 28, 2018
Closed
@pillarsdotnet
Copy link
Contributor Author

pillarsdotnet commented Nov 28, 2018 •
edited

@acozine - Submitted backport PR #49223

@abadger
Copy link
Contributor

abadger commented Nov 28, 2018

I don't think we want to do this quite like this. We do not want to tell people to use a decimal number in a mode or umask.

There's a couple options:

  • We could, as @robinro suggested, make numbers illegal. The umask must be specified as a string which we can then always treat as octal
  • We could make this work for octal strings and for numbers which we assume were entered as octal in the first place. This would match with other mode and umask implementations in modules.

At the very least we need to remove lines 104-106 as we do not document buggy behaviour.

@webknjaz
Copy link
Member

@abadger maybe we could have some special type and a helper class in basic? It'd unify mask processing across all modules.

@pillarsdotnet pillarsdotnet mentioned this pull request Nov 29, 2018
Merged
mjmayer pushed a commit to mjmayer/ansible that referenced this pull request Nov 30, 2018
@pillarsdotnet @mjmayer
Improve docs for umask option of pip module. (ansible#49146)
e562ab3 
* Improve docs for umask option of pip module; umask should be specified as an octal *string*, not an octal (or decimal) *integer*.
acozine pushed a commit that referenced this pull request Nov 30, 2018
@pillarsdotnet @acozine
Improve pip umask docs (#49146, #49325) (#49326)
9a5a4fa 
* For the pip module, umask should be specified as an octal *string*, not an octal (or decimal) *integer*.
(cherry picked from commit 0521e1c)
(cherry picked from commit 237f127)

* Do not document buggy behavior.
(cherry picked from commit 1b77d72)
@dagwieers dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Dec 10, 2018
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@webknjaz webknjaz webknjaz approved these changes

@abadger abadger Awaiting requested review from abadger

@acozine acozine Awaiting requested review from acozine

Assignees
No one assigned
Labels
affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite_pr This PR is created from documentation using the "Edit on GitHub" link. module This issue/PR relates to a module. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pip umask parameter does not work with octal (int) umask values
6 participants
@pillarsdotnet @ansibot @acozine @abadger @webknjaz @dagwieers