summaryrefslogtreecommitdiff
path: root/process.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-09-10 13:15:55 (GMT)
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-09-10 13:15:55 (GMT)
commit9fb0863f4f760dfb1b5deb47b37a32cc96b26478 (patch)
tree74ca614b720045f35aebf591f28dc2f1073630fe /process.c
parent5c09cb9c1e38fd262e2af4e6ddda0069384a0ebd (diff)
Clarify spawn pgroup documentation [ci skip]
* process.c (rb_f_spawn): Be more specific regarding "other values" by having "non-zero positive integers" Add nil, the default value, as a possible value and what it means. Try to use more consistent language. [Fix GH-1008] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51819 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'process.c')
-rw-r--r--process.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/process.c b/process.c
index f915ff6..c812e91 100644
--- a/process.c
+++ b/process.c
@@ -4062,7 +4062,7 @@ rb_f_system(int argc, VALUE *argv)
* :unsetenv_others => false : don't clear (default)
* process group:
* :pgroup => true or 0 : make a new process group
- * :pgroup => pgid : join to specified process group
+ * :pgroup => pgid : join the specified process group
* :pgroup => nil : don't change the process group (default)
* create new process group: Windows only
* :new_pgroup => true : the new process is the root process of a new process group
@@ -4127,10 +4127,10 @@ rb_f_system(int argc, VALUE *argv)
* pid = spawn({"FOO"=>"BAR"}, command, :unsetenv_others=>true) # FOO only
*
* The <code>:pgroup</code> key in +options+ specifies a process group.
- * The corresponding value should be true, zero or positive integer.
- * true and zero means the process should be a process leader of a new
- * process group.
- * Other values specifies a process group to be belongs.
+ * The corresponding value should be true, zero, a positive integer, or nil.
+ * true and zero cause the process to be a process leader of a new process group.
+ * A non-zero positive integer causes the process to join the provided process group.
+ * The default value, nil, causes the process to remain in the same process group.
*
* pid = spawn(command, :pgroup=>true) # process leader
* pid = spawn(command, :pgroup=>10) # belongs to the process group 10