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

Fri Jun 10 04:50:15 EDT 2016

https://hg.python.org/cpython/rev/e6093676e93b
changeset: 101846:e6093676e93b
branch: 3.5
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 | 14 ++++++++++----
 1 files changed, 10 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
@@ -1623,9 +1623,15 @@
 
 Create a directory named *path* with numeric mode *mode*.
 
+ If the directory already exists, :exc:`FileExistsError` is raised.
+
+ .. _mkdir_modebits:
+
 On some systems, *mode* is ignored. Where it is used, the current umask
- value is first masked out. If the directory already exists,
- :exc:`FileExistsError` is raised.
+ 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.
 
 This function can also support :ref:`paths relative to directory descriptors
 <dir_fd>`.
@@ -1646,8 +1652,8 @@
 Recursive directory creation function. Like :func:`mkdir`, but makes all
 intermediate-level directories needed to contain the leaf directory.
 
- The default *mode* is ``0o777`` (octal). On some systems, *mode* is
- ignored. Where it is used, the current umask value is first masked out.
+ The *mode* parameter is passed to :func:`mkdir`; see :ref:`the mkdir()
+ description <mkdir_modebits>` for how it is interpreted.
 
 If *exist_ok* is ``False`` (the default), an :exc:`OSError` is raised if the
 target directory already exists.
-- 
Repository URL: https://hg.python.org/cpython
