From: Raymond Hettinger <python@rcn.com>
Date: Mon, 6 Jan 2003 13:31:26 +0000 (+0000)
Subject: SF bug #592859: os.chmod is underdocumented
X-Git-Tag: v2.3c1~2571
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9f5b07dd922d151663b22609f417abb6d148330f;p=python

SF bug #592859: os.chmod is underdocumented

Document constants for permission bits.
---

diff --git a/Doc/lib/libos.tex b/Doc/lib/libos.tex
index c93c83542c..a2c013b7dc 100644
--- a/Doc/lib/libos.tex
+++ b/Doc/lib/libos.tex
@@ -653,6 +653,28 @@ Availability: \UNIX.
 
 \begin{funcdesc}{chmod}{path, mode}
 Change the mode of \var{path} to the numeric \var{mode}.
+\var{mode} may take one of the following values:
+\begin{itemize}
+  \item \code{S_ISUID}
+  \item \code{S_ISGID}
+  \item \code{S_ENFMT}
+  \item \code{S_ISVTX}
+  \item \code{S_IREAD}
+  \item \code{S_IWRITE}
+  \item \code{S_IEXEC}
+  \item \code{S_IRWXU}
+  \item \code{S_IRUSR}
+  \item \code{S_IWUSR}
+  \item \code{S_IXUSR}
+  \item \code{S_IRWXG}
+  \item \code{S_IRGRP}
+  \item \code{S_IWGRP}
+  \item \code{S_IXGRP}
+  \item \code{S_IRWXO}
+  \item \code{S_IROTH}
+  \item \code{S_IWOTH}
+  \item \code{S_IXOTH}
+\end{itemize}
 Availability: \UNIX, Windows.
 \end{funcdesc}