diff options
Diffstat (limited to 'Documentation/cmd-create-group.txt')
| -rw-r--r-- | Documentation/cmd-create-group.txt | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/Documentation/cmd-create-group.txt b/Documentation/cmd-create-group.txt index 1e46e14e19..475d2c5664 100644 --- a/Documentation/cmd-create-group.txt +++ b/Documentation/cmd-create-group.txt @@ -8,12 +8,13 @@ gerrit create-group - Create a new account group. SYNOPSIS -------- [verse] -'ssh' -p <port> <host> 'gerrit create-group' \ -[\--owner <GROUP>] \ -[\--description <DESC>] \ -[\--member <USERNAME>] \ -[\--group <GROUP>] \ -<GROUP> +'ssh' -p <port> <host> 'gerrit create-group' + [--owner <GROUP>] + [--description <DESC>] + [--member <USERNAME>] + [--group <GROUP>] + [--visible-to-all] + <GROUP> DESCRIPTION ----------- @@ -26,7 +27,9 @@ becomes a member of the newly created group. ACCESS ------ -Caller must be a member of the privileged 'Administrators' group. +Caller must be a member of the privileged 'Administrators' group, +or have been granted +link:access-control.html#capability_createGroup[the 'Create Group' global capability]. SCRIPTING --------- @@ -37,24 +40,27 @@ OPTIONS <GROUP>:: Required; name of the new group. -\--owner, -o:: +--owner, -o:: Name of the owning group. If not specified the group will be self-owning. -\--description, -d:: +--description, -d:: Description of group. + Description values containing spaces should be quoted in single quotes -(\'). This most likely requires double quoting the value, for example -`\--description "\'A description string\'"`. +('). This most likely requires double quoting the value, for example +`--description "'A description string'"`. -\--member:: - User name to become initial member of the group. Multiple \--member +--member:: + User name to become initial member of the group. Multiple --member options may be specified to add more initial members. -\--group:: - Group name to include in the group. Multiple \--group options may +--group:: + Group name to include in the group. Multiple --group options may be specified to include more initial groups. +--visible-to-all:: + If specified, the group members will be visible to all users. + EXAMPLES -------- Create a new account group called `gerritdev` with two initial members |