blob: 5fb2bb94ede8602779bc206b337d37f6cb930f4b [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit set-members
David Ostrovsky4adb97e2013-06-11 01:01:28 +02002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
David Ostrovsky4adb97e2013-06-11 01:01:28 +02004gerrit set-members - Set group members
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Michael Ochmanne2d76a12016-06-23 17:07:37 +02007[verse]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08008--
Michael Ochmanne2d76a12016-06-23 17:07:37 +02009_ssh_ -p <port> <host> _gerrit set-members_
David Ostrovsky4adb97e2013-06-11 01:01:28 +020010 [--add USER ...]
11 [--remove USER ...]
12 [--include GROUP ...]
13 [--exclude GROUP ...]
14 [--]
15 <GROUP> ...
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080016--
David Ostrovsky4adb97e2013-06-11 01:01:28 +020017
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080018== DESCRIPTION
David Ostrovsky4adb97e2013-06-11 01:01:28 +020019Set the group members for the specified groups.
20
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080021== OPTIONS
David Ostrovsky4adb97e2013-06-11 01:01:28 +020022<GROUP>::
23 Required; name of the group for which the members should be set.
24 The members for multiple groups can be set at once by specifying
25 multiple groups.
26
27--add::
28-a::
29 A user that should be added to the specified groups. Multiple
30 users can be added at once by using this option multiple times.
31
32--remove::
33-r::
34 Remove this user from the specified groups. Multiple users can be
35 removed at once by using this option multiple times.
36
37--include::
38-i::
39 A group that should be included to the specified groups. Multiple
40 groups can be included at once by using this option multiple
41 times.
42
43--exclude::
44-e::
45 Exclude this group from the specified groups. Multiple groups can
46 be excluded at once by using this option multiple times.
47
48The `set-members` command is processing the options in the following
49order: `--remove`, `--exclude`, `--add`, `--include`
50
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080051== ACCESS
Gert van Dijkdc4f8d12017-08-27 21:14:23 +020052Any user who has SSH access to Gerrit.
David Ostrovsky4adb97e2013-06-11 01:01:28 +020053
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080054== SCRIPTING
David Ostrovsky4adb97e2013-06-11 01:01:28 +020055This command is intended to be used in scripts.
56
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080057== EXAMPLES
David Ostrovsky4adb97e2013-06-11 01:01:28 +020058
59Add alice and bob, but remove eve from the groups my-committers and
60my-verifiers.
Michael Ochmannb99feab2016-07-06 14:10:22 +020061----
David Ostrovsky4adb97e2013-06-11 01:01:28 +020062 $ ssh -p 29418 review.example.com gerrit set-members \
63 -a alice@example.com -a bob@example.com \
64 -r eve@example.com my-committers my-verifiers
Michael Ochmannb99feab2016-07-06 14:10:22 +020065----
David Ostrovsky4adb97e2013-06-11 01:01:28 +020066
67Include the group my-friends into the group my-committers, but
68exclude the included group my-testers from the group my-committers.
Michael Ochmannb99feab2016-07-06 14:10:22 +020069----
David Ostrovsky4adb97e2013-06-11 01:01:28 +020070 $ ssh -p 29418 review.example.com gerrit set-members \
71 -i my-friends -e my-testers my-committers
Michael Ochmannb99feab2016-07-06 14:10:22 +020072----
David Ostrovsky4adb97e2013-06-11 01:01:28 +020073
74GERRIT
75------
76Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070077
78SEARCHBOX
79---------