gerrit/Documentation/cmd-ls-user-refs.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

53 lines
1.2 KiB
Plaintext

= gerrit ls-user-refs
== NAME
gerrit ls-user-refs - List refs visible to a specific user
== SYNOPSIS
--
'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 database 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
---------