Skip to content

Commit

Permalink
[DOC] Enhanced Process.groups related
Browse files Browse the repository at this point in the history
* On some platforms (e.g., macOS), the user's default group access
  list may exceed `NGROUPS_MAX`.
* Use upcase "GID" instead of "gid" for other than variable names.
  • Loading branch information
nobu committed Jan 19, 2022
1 parent e724929 commit 2f0f56b
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions process.c
Expand Up @@ -6852,6 +6852,7 @@ maxgroups(void)
* - the result is sorted
* - the result includes effective GIDs
* - the result does not include duplicated GIDs
* - the result size does not exceed the value of Process.maxgroups
*
* You can make sure to get a sorted unique GID list of
* the current process by this expression:
Expand Down Expand Up @@ -6946,10 +6947,10 @@ proc_setgroups(VALUE obj, VALUE ary)
*
* Initializes the supplemental group access list by reading the
* system group database and using all groups of which the given user
* is a member. The group with the specified <em>gid</em> is also
* added to the list. Returns the resulting Array of the
* gids of all the groups in the supplementary group access list. Not
* available on all platforms.
* is a member. The group with the specified _gid_ is also added to
* the list. Returns the resulting Array of the GIDs of all the
* groups in the supplementary group access list. Not available on
* all platforms.
*
* Process.groups #=> [0, 1, 2, 3, 4, 6, 10, 11, 20, 26, 27]
* Process.initgroups( "mgranger", 30 ) #=> [30, 6, 10, 11]
Expand All @@ -6974,7 +6975,7 @@ proc_initgroups(VALUE obj, VALUE uname, VALUE base_grp)
* call-seq:
* Process.maxgroups -> integer
*
* Returns the maximum number of gids allowed in the supplemental
* Returns the maximum number of GIDs allowed in the supplemental
* group access list.
*
* Process.maxgroups #=> 32
Expand All @@ -6994,7 +6995,7 @@ proc_getmaxgroups(VALUE obj)
* call-seq:
* Process.maxgroups= integer -> integer
*
* Sets the maximum number of gids allowed in the supplemental group
* Sets the maximum number of GIDs allowed in the supplemental group
* access list.
*/

Expand Down

0 comments on commit 2f0f56b

Please sign in to comment.