blob: 11781debe4fcda2e3f4f46d761450176a5eea969 [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08001= gerrit ls-user-refs
Gustaf Lundhbf53a702012-11-15 18:24:32 -08002
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08003== NAME
Gustaf Lundhbf53a702012-11-15 18:24:32 -08004gerrit ls-user-refs - List refs visible to a specific user
5
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08006== SYNOPSIS
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -08007--
Christian Aistleitner870fad22013-05-01 12:19:28 +02008'ssh' -p <port> <host> 'gerrit ls-user-refs'
Gustaf Lundhbf53a702012-11-15 18:24:32 -08009 [--project PROJECT> | -p <PROJECT>]
10 [--user <USER> | -u <USER>]
Gustaf Lundh2f7bdc12012-11-18 18:24:39 -080011 [--only-refs-heads]
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080012--
Gustaf Lundhbf53a702012-11-15 18:24:32 -080013
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080014== DESCRIPTION
Gustaf Lundhbf53a702012-11-15 18:24:32 -080015Displays all refs that the specified user can see.
16
17Allows an administrator to query which refs are visible for
18a user. The command is helpful for admins when debugging why a
19user cannot access certain refs and also to help admins
20verify that certain secret refs are not exposed to the wrong
21groups.
22
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080023== ACCESS
Gustaf Lundhbf53a702012-11-15 18:24:32 -080024Administrators
25
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080026== OPTIONS
Gustaf Lundhbf53a702012-11-15 18:24:32 -080027--project::
28-p::
Christian Aistleitnera0e111e2013-04-30 20:17:29 +020029 Required; Name of the project for which the refs should be listed.
Gustaf Lundhbf53a702012-11-15 18:24:32 -080030
31--user::
32-u::
Christian Aistleitnera0e111e2013-04-30 20:17:29 +020033 Required; User for which the visible refs should be listed. Gerrit
Gustaf Lundhbf53a702012-11-15 18:24:32 -080034 will query the database to find matching users, so the
35 full identity/name does not need to be specified.
36
Gustaf Lundh2f7bdc12012-11-18 18:24:39 -080037--only-refs-heads::
38 Only list the refs found under refs/heads/*
39
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080040== EXAMPLES
Gustaf Lundhbf53a702012-11-15 18:24:32 -080041
42List visible refs for the user "mr.developer" in project "gerrit"
43=====
44 $ ssh -p 29418 review.example.com gerrit ls-user-refs -p gerrit -u mr.developer
45=====
46
47GERRIT
48------
49Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070050
51SEARCHBOX
52---------