gerrit/Documentation/cmd-ls-user-refs.txt
Dave Borowitz ada289c6df Update most documentation for NoteDb
Remove outdated references to ReviewDb. Where ambiguous terms like
"database" are used, make sure they are still technically accurate, or
else remove them.

After this change, all documentation should be up to date with respect
to the database backend, with the exception of note-db.txt itself.

Change-Id: I7134087dc56070788e81ada6ac504b3c8fe84c4c
2019-01-11 14:44:23 -08:00

54 lines
1.2 KiB
Plaintext

= gerrit ls-user-refs
== NAME
gerrit ls-user-refs - List refs visible to a specific user.
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit ls-user-refs_
[--project PROJECT> | -p <PROJECT>]
[--user <USER> | -u <USER>]
[--only-refs-heads]
--
== DESCRIPTION
Displays all refs that the specified user can see.
Allows an administrator to query which refs are visible for
a user. The command is helpful for admins when debugging why a
user cannot access certain refs and also to help admins
verify that certain secret refs are not exposed to the wrong
groups.
== ACCESS
Administrators
== OPTIONS
--project::
-p::
Required; Name of the project for which the refs should be listed.
--user::
-u::
Required; User for which the visible refs should be listed. Gerrit
will query the index to find matching users, so the full
identity/name does not need to be specified.
--only-refs-heads::
Only list the refs found under refs/heads/*
== EXAMPLES
List visible refs for the user "mr.developer" in project "gerrit"
----
$ ssh -p 29418 review.example.com gerrit ls-user-refs -p gerrit -u mr.developer
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------