9ad2761e04
1. cmd-ls-projects.txt: second paragraph explaining the '--description' option is wrongly formatted as literal style (see http://www.methods.co.nz/asciidoc/userguide.html#X85) 2. access-control.txt: '*' doesn't need to be escaped anymore Change-Id: Ied77ba2f91968e2c8b378695cca0dca926d4a8ad Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
102 lines
2.4 KiB
Plaintext
102 lines
2.4 KiB
Plaintext
gerrit ls-projects
|
|
==================
|
|
|
|
NAME
|
|
----
|
|
gerrit ls-projects - List projects visible to caller
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'ssh' -p <port> <host> 'gerrit ls-projects'
|
|
[--show-branch <BRANCH> ...]
|
|
[--tree]
|
|
[--type {code | permissions | all}]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Displays the list of project names, one per line, that the
|
|
calling user account has been granted 'READ' access to.
|
|
|
|
If the caller is a member of the privileged 'Administrators'
|
|
group, all projects are listed.
|
|
|
|
ACCESS
|
|
------
|
|
Any user who has configured an SSH key.
|
|
|
|
SCRIPTING
|
|
---------
|
|
This command is intended to be used in scripts.
|
|
|
|
OPTIONS
|
|
-------
|
|
--show-branch::
|
|
-b::
|
|
Branch for which the command will display the sha of each project.
|
|
The command may have multiple --show-branch parameters, in this case
|
|
sha will be shown for each of the branches.
|
|
If the user does not have READ access to some branch or the branch does not
|
|
exist then stub (40 `-` symbols) is shown.
|
|
If the user does not have access to any branch in the project then the
|
|
whole project is not shown.
|
|
|
|
--description::
|
|
--d::
|
|
Allows listing of projects together with their respective
|
|
description.
|
|
+
|
|
Line-feeds are escaped to allow ls-project to keep the
|
|
"one project per line"-style.
|
|
|
|
--tree::
|
|
-t::
|
|
Displays project inheritance in a tree-like format.
|
|
This option does not work together with the show-branch option.
|
|
|
|
--type::
|
|
Display only projects of the specified type. If not
|
|
specified, defaults to `code`. Supported types:
|
|
|
|
--all::
|
|
Display all projects that are accessible by the calling user
|
|
account. Besides the projects that the calling user account has
|
|
been granted 'READ' access to, this includes all projects that
|
|
are owned by the calling user account (even if for these projects
|
|
the 'READ' access right is not assigned to the calling user
|
|
account).
|
|
+
|
|
--
|
|
`code`:: Any project likely to contain user files.
|
|
`permissions`:: Projects created with the `--permissions-only` flag.
|
|
`all`:: Any type of project.
|
|
--
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
List visible projects:
|
|
=====
|
|
$ ssh -p 29418 review.example.com gerrit ls-projects
|
|
tools/gerrit
|
|
tools/gwtorm
|
|
=====
|
|
|
|
Clone any project visible to the user:
|
|
====
|
|
for p in `ssh -p 29418 review.example.com gerrit ls-projects`
|
|
do
|
|
mkdir -p `dirname "$p"`
|
|
git clone --bare "ssh://review.example.com:29418/$p.git" "$p.git"
|
|
done
|
|
====
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
* link:access-control.html[Access Controls]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|