gerrit/Documentation/cmd-set-members.txt
Yuxuan 'fishy' Wang 61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00

79 lines
1.8 KiB
Plaintext

= gerrit set-members
== NAME
gerrit set-members - Set group members
== SYNOPSIS
--
'ssh' -p <port> <host> 'gerrit set-members'
[--add USER ...]
[--remove USER ...]
[--include GROUP ...]
[--exclude GROUP ...]
[--]
<GROUP> ...
--
== DESCRIPTION
Set the group members for the specified groups.
== OPTIONS
<GROUP>::
Required; name of the group for which the members should be set.
The members for multiple groups can be set at once by specifying
multiple groups.
--add::
-a::
A user that should be added to the specified groups. Multiple
users can be added at once by using this option multiple times.
--remove::
-r::
Remove this user from the specified groups. Multiple users can be
removed at once by using this option multiple times.
--include::
-i::
A group that should be included to the specified groups. Multiple
groups can be included at once by using this option multiple
times.
--exclude::
-e::
Exclude this group from the specified groups. Multiple groups can
be excluded at once by using this option multiple times.
The `set-members` command is processing the options in the following
order: `--remove`, `--exclude`, `--add`, `--include`
== ACCESS
Any user who has configured an SSH key.
== SCRIPTING
This command is intended to be used in scripts.
== EXAMPLES
Add alice and bob, but remove eve from the groups my-committers and
my-verifiers.
=====
$ ssh -p 29418 review.example.com gerrit set-members \
-a alice@example.com -a bob@example.com \
-r eve@example.com my-committers my-verifiers
=====
Include the group my-friends into the group my-committers, but
exclude the included group my-testers from the group my-committers.
=====
$ ssh -p 29418 review.example.com gerrit set-members \
-i my-friends -e my-testers my-committers
=====
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------