Improve docs for umask option of pip module.

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

+label: docsite_pr
This commit is contained in:
Bob Vincent 2018-11-26 12:49:07 -05:00 committed by GitHub
parent 02893520a9
commit 0521e1c6dc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -98,9 +98,13 @@ options:
description: description:
- The system umask to apply before installing the pip package. This is - The system umask to apply before installing the pip package. This is
useful, for example, when installing on systems that have a very useful, for example, when installing on systems that have a very
restrictive umask by default (e.g., 0077) and you want to pip install restrictive umask by default (e.g., "0077") and you want to pip install
packages which are to be used by all users. Note that this requires you packages which are to be used by all users. Note that this requires you
to specify desired umask mode in octal, with a leading 0 (e.g., 0077). to specify desired umask mode as an octal string, with a leading 0
(e.g., "0022"). Specifying the mode as a decimal integer (e.g., 22)
will also work, but an octal integer (e.g., 0022) will be converted to
decimal (18) before evaluation, which is almost certainly not what was
intended.
version_added: "2.1" version_added: "2.1"
notes: notes:
- Please note that virtualenv (U(http://www.virtualenv.org/)) must be - Please note that virtualenv (U(http://www.virtualenv.org/)) must be