classification
Title: Incorrect docstring of os.setpgrp
Type: Stage: resolved
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eggy, orsenthil, terry.reedy
Priority: normal Keywords:

Created on 2008-11-28 14:23 by eggy, last changed 2010-06-17 16:52 by orsenthil. This issue is now closed.

Messages (4)
msg76529 - (view) Author: Mark Florisson (eggy) * Date: 2008-11-28 14:23
The docstring of os.setpgrp says 'Make this process a session leader.',
but that's not what setpgrp does. setpgrp() is the same as setpgid(0,
0), which sets the pgid of the calling process to the pid of the calling
process, thus making it a process group leader, not a session leader (it
will still be in the same session). It might say instead 'Make this
process a process group leader.'.
msg107984 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-06-17 02:01
os.setpgrp is unix only, I am windows only ;-(.
However, the 3.1 manual says "Call the system call setpgrp() or setpgrp(0, 0)() depending on which version is implemented (if any). "

Given the name of the function and the above, I suspect the OP is correct. The change is small enough that I might not bother with 2.6 and 3.1.
msg108031 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2010-06-17 16:32
Yes, its valid doc change request. Thought it means the same, the minor docstring improvement can be done.
msg108036 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2010-06-17 16:52
The docstring "Make this process the process group leader" is proper for setpgrp. Fixed in r82047, r82048, r82049 and r82050.
History
Date User Action Args
2010-06-17 16:52:58orsenthilsetstatus: open -> closed
resolution: fixed
messages: + msg108036

stage: resolved
2010-06-17 16:32:34orsenthilsetnosy: + orsenthil
messages: + msg108031
2010-06-17 02:01:05terry.reedysetversions: + Python 3.1, Python 2.7, Python 3.2, - Python 2.5, Python 2.4, Python 3.0
nosy: + docs@python, terry.reedy

messages: + msg107984

assignee: docs@python
components: + Documentation
2008-11-28 14:23:29eggycreate