blob: 174a25a39d6d7e75869a75b50a9cb41b60523eb7 [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
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
David Ostrovsky4adb97e2013-06-11 01:01:28 +02008'ssh' -p <port> <host> 'gerrit set-members'
9 [--add USER ...]
10 [--remove USER ...]
11 [--include GROUP ...]
12 [--exclude GROUP ...]
13 [--]
14 <GROUP> ...
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080015--
David Ostrovsky4adb97e2013-06-11 01:01:28 +020016
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080017== DESCRIPTION
David Ostrovsky4adb97e2013-06-11 01:01:28 +020018Set the group members for the specified groups.
19
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080020== OPTIONS
David Ostrovsky4adb97e2013-06-11 01:01:28 +020021<GROUP>::
22 Required; name of the group for which the members should be set.
23 The members for multiple groups can be set at once by specifying
24 multiple groups.
25
26--add::
27-a::
28 A user that should be added to the specified groups. Multiple
29 users can be added at once by using this option multiple times.
30
31--remove::
32-r::
33 Remove this user from the specified groups. Multiple users can be
34 removed at once by using this option multiple times.
35
36--include::
37-i::
38 A group that should be included to the specified groups. Multiple
39 groups can be included at once by using this option multiple
40 times.
41
42--exclude::
43-e::
44 Exclude this group from the specified groups. Multiple groups can
45 be excluded at once by using this option multiple times.
46
47The `set-members` command is processing the options in the following
48order: `--remove`, `--exclude`, `--add`, `--include`
49
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080050== ACCESS
David Ostrovsky4adb97e2013-06-11 01:01:28 +020051Any user who has configured an SSH key.
52
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080053== SCRIPTING
David Ostrovsky4adb97e2013-06-11 01:01:28 +020054This command is intended to be used in scripts.
55
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080056== EXAMPLES
David Ostrovsky4adb97e2013-06-11 01:01:28 +020057
58Add alice and bob, but remove eve from the groups my-committers and
59my-verifiers.
60=====
61 $ ssh -p 29418 review.example.com gerrit set-members \
62 -a alice@example.com -a bob@example.com \
63 -r eve@example.com my-committers my-verifiers
64=====
65
66Include the group my-friends into the group my-committers, but
67exclude the included group my-testers from the group my-committers.
68=====
69 $ ssh -p 29418 review.example.com gerrit set-members \
70 -i my-friends -e my-testers my-committers
71=====
72
73GERRIT
74------
75Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070076
77SEARCHBOX
78---------