about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2022-07-16 14:45:16 -0700
committerGitHub <noreply@github.com>2022-07-16 14:45:16 -0700
commit629b0b488b3e84ce389c71a10ca3ca976bf05d92 (patch)
treee8e32e7cfc81c9134e5c15d6190c4f37177ff963
parentb028bbf9d0618f0f4af279d33b7a057a8072eb18 (diff)
downloadrust-629b0b488b3e84ce389c71a10ca3ca976bf05d92.tar.gz
rust-629b0b488b3e84ce389c71a10ca3ca976bf05d92.zip
Expand documentation for `process_group`
Explain PGID 0, and provide the acronym PGID.
-rw-r--r--library/std/src/os/unix/process.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/library/std/src/os/unix/process.rs b/library/std/src/os/unix/process.rs
index bd6d431f8e4..09b2bfe39f0 100644
--- a/library/std/src/os/unix/process.rs
+++ b/library/std/src/os/unix/process.rs
@@ -148,7 +148,7 @@ pub trait CommandExt: Sealed {
     where
         S: AsRef<OsStr>;
 
-    /// Sets the process group ID of the child process. Equivalent to a
+    /// Sets the process group ID (PGID) of the child process. Equivalent to a
     /// `setpgid` call in the child process, but may be more efficient.
     ///
     /// Process groups determine which processes receive signals.
@@ -163,6 +163,8 @@ pub trait CommandExt: Sealed {
     /// The parent process could install a signal handler and manage the
     /// subprocess on its own terms.
     ///
+    /// A process group ID of 0 will use the process ID as the PGID.
+    ///
     /// ```no_run
     /// use std::process::Command;
     /// use std::os::unix::process::CommandExt;