2021-06-20 12:41:05 +00:00
|
|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
|
2022-07-10 09:15:19 +00:00
|
|
|
.TH REPO "1" "July 2022" "repo" "Repo Manual"
|
2021-06-20 12:41:05 +00:00
|
|
|
.SH NAME
|
|
|
|
|
repo \- repository management tool built on top of git
|
repo: refactor help output handling
Currently we have the behavior:
* `repo`: Equivalent to `repo help` -- only shows common subcommands
(with short description), and then exits 0.
* `repo --help`: Shows repo's core options, lists all commands (no
specific info), and then exits 0.
The first case is not behaving well:
* If you run `repo` without a specific subcommand, that's an error,
so we should be exiting 1 instead.
* Showing only subcommands and no actual option summary makes it seem
like repo itself doesn't take any options. This confuses users.
Let's rework things a bit. Now we have the behavior:
* `repo`: Shows repo's core options, lists all commands (no specific
info), and then exits 1.
* `repo --help`: Shows repo's core options, shows common subcommands
(with short description), and then exits 0.
* `repo --help-all`: Shows repo's core options, shows all subcommands
(with short description), and then exits 0.
Basically we swap the behavior of `repo` and `repo --help`, and fix
the exit status when the subcommand is missing.
The addition of --help-all is mostly for the man pages. We were
relying on `repo help --all` to generate the repo(1) man page, but
that too omitted the core repo options. Now the man page includes
all the core repo options and provides a summary of all commands.
Change-Id: I1f99b99d5b8af2591f96a078d0647a3d76d6b0fc
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/312908
Reviewed-by: Xin Li <delphij@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
2021-07-27 03:46:32 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B repo
|
|
|
|
|
[\fI\,-p|--paginate|--no-pager\/\fR] \fI\,COMMAND \/\fR[\fI\,ARGS\/\fR]
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
show this help message and exit
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-help\-all\fR
|
|
|
|
|
show this help message with all subcommands and exit
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-p\fR, \fB\-\-paginate\fR
|
|
|
|
|
display command output in the pager
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-no\-pager\fR
|
|
|
|
|
disable the pager
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-color\fR=\fI\,COLOR\/\fR
|
|
|
|
|
control color usage: auto, always, never
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-trace\fR
|
|
|
|
|
trace git command execution (REPO_TRACE=1)
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-trace\-python\fR
|
|
|
|
|
trace python command execution
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-time\fR
|
|
|
|
|
time repo command execution
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-version\fR
|
|
|
|
|
display this version of repo
|
|
|
|
|
.TP
|
2021-07-26 19:42:59 +00:00
|
|
|
\fB\-\-show\-toplevel\fR
|
|
|
|
|
display the path of the top\-level directory of the
|
|
|
|
|
repo client checkout
|
|
|
|
|
.TP
|
repo: refactor help output handling
Currently we have the behavior:
* `repo`: Equivalent to `repo help` -- only shows common subcommands
(with short description), and then exits 0.
* `repo --help`: Shows repo's core options, lists all commands (no
specific info), and then exits 0.
The first case is not behaving well:
* If you run `repo` without a specific subcommand, that's an error,
so we should be exiting 1 instead.
* Showing only subcommands and no actual option summary makes it seem
like repo itself doesn't take any options. This confuses users.
Let's rework things a bit. Now we have the behavior:
* `repo`: Shows repo's core options, lists all commands (no specific
info), and then exits 1.
* `repo --help`: Shows repo's core options, shows common subcommands
(with short description), and then exits 0.
* `repo --help-all`: Shows repo's core options, shows all subcommands
(with short description), and then exits 0.
Basically we swap the behavior of `repo` and `repo --help`, and fix
the exit status when the subcommand is missing.
The addition of --help-all is mostly for the man pages. We were
relying on `repo help --all` to generate the repo(1) man page, but
that too omitted the core repo options. Now the man page includes
all the core repo options and provides a summary of all commands.
Change-Id: I1f99b99d5b8af2591f96a078d0647a3d76d6b0fc
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/312908
Reviewed-by: Xin Li <delphij@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
2021-07-27 03:46:32 +00:00
|
|
|
\fB\-\-event\-log\fR=\fI\,EVENT_LOG\/\fR
|
|
|
|
|
filename of event log to append timeline to
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-git\-trace2\-event\-log\fR=\fI\,GIT_TRACE2_EVENT_LOG\/\fR
|
|
|
|
|
directory to write git trace2 event log to
|
2022-07-10 09:15:19 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-submanifest\-path\fR=\fI\,REL_PATH\/\fR
|
|
|
|
|
submanifest path
|
2021-11-12 06:39:21 +00:00
|
|
|
.SS "The complete list of recognized repo commands is:"
|
2021-06-20 12:41:05 +00:00
|
|
|
.TP
|
|
|
|
|
abandon
|
|
|
|
|
Permanently abandon a development branch
|
|
|
|
|
.TP
|
|
|
|
|
branch
|
|
|
|
|
View current topic branches
|
|
|
|
|
.TP
|
|
|
|
|
branches
|
|
|
|
|
View current topic branches
|
|
|
|
|
.TP
|
|
|
|
|
checkout
|
|
|
|
|
Checkout a branch for development
|
|
|
|
|
.TP
|
|
|
|
|
cherry\-pick
|
|
|
|
|
Cherry\-pick a change.
|
|
|
|
|
.TP
|
|
|
|
|
diff
|
|
|
|
|
Show changes between commit and working tree
|
|
|
|
|
.TP
|
|
|
|
|
diffmanifests
|
|
|
|
|
Manifest diff utility
|
|
|
|
|
.TP
|
|
|
|
|
download
|
|
|
|
|
Download and checkout a change
|
|
|
|
|
.TP
|
|
|
|
|
forall
|
|
|
|
|
Run a shell command in each project
|
|
|
|
|
.TP
|
|
|
|
|
gitc\-delete
|
|
|
|
|
Delete a GITC Client.
|
|
|
|
|
.TP
|
|
|
|
|
gitc\-init
|
|
|
|
|
Initialize a GITC Client.
|
|
|
|
|
.TP
|
|
|
|
|
grep
|
|
|
|
|
Print lines matching a pattern
|
|
|
|
|
.TP
|
|
|
|
|
help
|
|
|
|
|
Display detailed help on a command
|
|
|
|
|
.TP
|
|
|
|
|
info
|
|
|
|
|
Get info on the manifest branch, current branch or unmerged branches
|
|
|
|
|
.TP
|
|
|
|
|
init
|
|
|
|
|
Initialize a repo client checkout in the current directory
|
|
|
|
|
.TP
|
|
|
|
|
list
|
|
|
|
|
List projects and their associated directories
|
|
|
|
|
.TP
|
|
|
|
|
manifest
|
|
|
|
|
Manifest inspection utility
|
|
|
|
|
.TP
|
|
|
|
|
overview
|
|
|
|
|
Display overview of unmerged project branches
|
|
|
|
|
.TP
|
|
|
|
|
prune
|
|
|
|
|
Prune (delete) already merged topics
|
|
|
|
|
.TP
|
|
|
|
|
rebase
|
|
|
|
|
Rebase local branches on upstream branch
|
|
|
|
|
.TP
|
|
|
|
|
selfupdate
|
|
|
|
|
Update repo to the latest version
|
|
|
|
|
.TP
|
|
|
|
|
smartsync
|
|
|
|
|
Update working tree to the latest known good revision
|
|
|
|
|
.TP
|
|
|
|
|
stage
|
|
|
|
|
Stage file(s) for commit
|
|
|
|
|
.TP
|
|
|
|
|
start
|
|
|
|
|
Start a new branch for development
|
|
|
|
|
.TP
|
|
|
|
|
status
|
|
|
|
|
Show the working tree status
|
|
|
|
|
.TP
|
|
|
|
|
sync
|
|
|
|
|
Update working tree to the latest revision
|
|
|
|
|
.TP
|
|
|
|
|
upload
|
|
|
|
|
Upload changes for code review
|
|
|
|
|
.TP
|
|
|
|
|
version
|
|
|
|
|
Display the version of repo
|
|
|
|
|
.PP
|
|
|
|
|
See 'repo help <command>' for more information on a specific command.
|
repo: refactor help output handling
Currently we have the behavior:
* `repo`: Equivalent to `repo help` -- only shows common subcommands
(with short description), and then exits 0.
* `repo --help`: Shows repo's core options, lists all commands (no
specific info), and then exits 0.
The first case is not behaving well:
* If you run `repo` without a specific subcommand, that's an error,
so we should be exiting 1 instead.
* Showing only subcommands and no actual option summary makes it seem
like repo itself doesn't take any options. This confuses users.
Let's rework things a bit. Now we have the behavior:
* `repo`: Shows repo's core options, lists all commands (no specific
info), and then exits 1.
* `repo --help`: Shows repo's core options, shows common subcommands
(with short description), and then exits 0.
* `repo --help-all`: Shows repo's core options, shows all subcommands
(with short description), and then exits 0.
Basically we swap the behavior of `repo` and `repo --help`, and fix
the exit status when the subcommand is missing.
The addition of --help-all is mostly for the man pages. We were
relying on `repo help --all` to generate the repo(1) man page, but
that too omitted the core repo options. Now the man page includes
all the core repo options and provides a summary of all commands.
Change-Id: I1f99b99d5b8af2591f96a078d0647a3d76d6b0fc
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/312908
Reviewed-by: Xin Li <delphij@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
2021-07-27 03:46:32 +00:00
|
|
|
Bug reports: https://bugs.chromium.org/p/gerrit/issues/entry?template=Repo+tool+issue
|
