[Python-checkins] cpython (2.7): Issue #24617: Add comment for os.mkdir about mode quirks

Fri Jun 10 04:50:15 EDT 2016

https://hg.python.org/cpython/rev/4fc7753efc89
changeset: 101844:4fc7753efc89
branch: 2.7
user: Tommy Beadle <tbeadle at gmail.com>
date: Thu Jun 02 15:41:20 2016 -0400
summary:
 Issue #24617: Add comment for os.mkdir about mode quirks
files:
 Doc/library/os.rst | 17 +++++++++++++----
 1 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1222,10 +1222,17 @@
 .. function:: mkdir(path[, mode])
 
 Create a directory named *path* with numeric mode *mode*. The default *mode* is
- ``0777`` (octal). On some systems, *mode* is ignored. Where it is used, the
- current umask value is first masked out. If the directory already exists,
+ ``0777`` (octal). If the directory already exists,
 :exc:`OSError` is raised.
 
+ .. _mkdir_modebits:
+
+ On some systems, *mode* is ignored. Where it is used, the current umask
+ value is first masked out. If bits other than the last 9 (i.e. the last 3
+ digits of the octal representation of the *mode*) are set, their meaning is
+ platform-dependent. On some platforms, they are ignored and you should call
+ :func:`chmod` explicitly to set them.
+
 It is also possible to create temporary directories; see the
 :mod:`tempfile` module's :func:`tempfile.mkdtemp` function.
 
@@ -1241,8 +1248,10 @@
 Recursive directory creation function. Like :func:`mkdir`, but makes all
 intermediate-level directories needed to contain the leaf directory. Raises an
 :exc:`error` exception if the leaf directory already exists or cannot be
- created. The default *mode* is ``0777`` (octal). On some systems, *mode* is
- ignored. Where it is used, the current umask value is first masked out.
+ created. The default *mode* is ``0777`` (octal).
+
+ The *mode* parameter is passed to :func:`mkdir`; see :ref:`the mkdir()
+ description <mkdir_modebits>` for how it is interpreted.
 
 .. note::
 
-- 
Repository URL: https://hg.python.org/cpython
