summaryrefslogtreecommitdiffstats
path: root/man/repo-upload.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/repo-upload.1')
-rw-r--r--man/repo-upload.1174
1 files changed, 174 insertions, 0 deletions
diff --git a/man/repo-upload.1 b/man/repo-upload.1
new file mode 100644
index 00000000..6deed047
--- /dev/null
+++ b/man/repo-upload.1
@@ -0,0 +1,174 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2021" "repo upload" "Repo Manual"
3.SH NAME
4repo \- repo upload - manual page for repo upload
5.SH SYNOPSIS
6.B repo
7\fI\,upload \/\fR[\fI\,--re --cc\/\fR] [\fI\,<project>\/\fR]...
8.SH DESCRIPTION
9Summary
10.PP
11Upload changes for code review
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.TP
17\fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
18number of jobs to run in parallel (default: 4)
19.TP
20\fB\-t\fR
21send local branch name to Gerrit Code Review
22.TP
23\fB\-\-hashtag\fR=\fI\,HASHTAGS\/\fR, \fB\-\-ht\fR=\fI\,HASHTAGS\/\fR
24add hashtags (comma delimited) to the review
25.TP
26\fB\-\-hashtag\-branch\fR, \fB\-\-htb\fR
27add local branch name as a hashtag
28.TP
29\fB\-l\fR LABELS, \fB\-\-label\fR=\fI\,LABELS\/\fR
30add a label when uploading
31.TP
32\fB\-\-re\fR=\fI\,REVIEWERS\/\fR, \fB\-\-reviewers\fR=\fI\,REVIEWERS\/\fR
33request reviews from these people
34.TP
35\fB\-\-cc\fR=\fI\,CC\/\fR
36also send email to these email addresses
37.TP
38\fB\-\-br\fR=\fI\,BRANCH\/\fR, \fB\-\-branch\fR=\fI\,BRANCH\/\fR
39(local) branch to upload
40.TP
41\fB\-c\fR, \fB\-\-current\-branch\fR
42upload current git branch
43.TP
44\fB\-\-no\-current\-branch\fR
45upload all git branches
46.TP
47\fB\-\-ne\fR, \fB\-\-no\-emails\fR
48do not send e\-mails on upload
49.TP
50\fB\-p\fR, \fB\-\-private\fR
51upload as a private change (deprecated; use \fB\-\-wip\fR)
52.TP
53\fB\-w\fR, \fB\-\-wip\fR
54upload as a work\-in\-progress change
55.TP
56\fB\-o\fR PUSH_OPTIONS, \fB\-\-push\-option\fR=\fI\,PUSH_OPTIONS\/\fR
57additional push options to transmit
58.TP
59\fB\-D\fR BRANCH, \fB\-\-destination\fR=\fI\,BRANCH\/\fR, \fB\-\-dest\fR=\fI\,BRANCH\/\fR
60submit for review on this target branch
61.TP
62\fB\-n\fR, \fB\-\-dry\-run\fR
63do everything except actually upload the CL
64.TP
65\fB\-y\fR, \fB\-\-yes\fR
66answer yes to all safe prompts
67.TP
68\fB\-\-no\-cert\-checks\fR
69disable verifying ssl certs (unsafe)
70.SS Logging options:
71.TP
72\fB\-v\fR, \fB\-\-verbose\fR
73show all output
74.TP
75\fB\-q\fR, \fB\-\-quiet\fR
76only show errors
77.SS pre\-upload hooks:
78.TP
79\fB\-\-no\-verify\fR
80Do not run the pre\-upload hook.
81.TP
82\fB\-\-verify\fR
83Run the pre\-upload hook without prompting.
84.TP
85\fB\-\-ignore\-hooks\fR
86Do not abort if pre\-upload hooks fail.
87.PP
88Run `repo help upload` to view the detailed manual.
89.SH DETAILS
90.PP
91The 'repo upload' command is used to send changes to the Gerrit Code Review
92system. It searches for topic branches in local projects that have not yet been
93published for review. If multiple topic branches are found, 'repo upload' opens
94an editor to allow the user to select which branches to upload.
95.PP
96\&'repo upload' searches for uploadable changes in all projects listed at the
97command line. Projects can be specified either by name, or by a relative or
98absolute path to the project's local directory. If no projects are specified,
99\&'repo upload' will search for uploadable changes in all projects listed in the
100manifest.
101.PP
102If the \fB\-\-reviewers\fR or \fB\-\-cc\fR options are passed, those emails are added to the
103respective list of users, and emails are sent to any new users. Users passed as
104\fB\-\-reviewers\fR must already be registered with the code review system, or the
105upload will fail.
106.PP
107Configuration
108.PP
109review.URL.autoupload:
110.PP
111To disable the "Upload ... (y/N)?" prompt, you can set a per\-project or global
112Git configuration option. If review.URL.autoupload is set to "true" then repo
113will assume you always answer "y" at the prompt, and will not prompt you
114further. If it is set to "false" then repo will assume you always answer "n",
115and will abort.
116.PP
117review.URL.autoreviewer:
118.PP
119To automatically append a user or mailing list to reviews, you can set a
120per\-project or global Git option to do so.
121.PP
122review.URL.autocopy:
123.PP
124To automatically copy a user or mailing list to all uploaded reviews, you can
125set a per\-project or global Git option to do so. Specifically,
126review.URL.autocopy can be set to a comma separated list of reviewers who you
127always want copied on all uploads with a non\-empty \fB\-\-re\fR argument.
128.PP
129review.URL.username:
130.PP
131Override the username used to connect to Gerrit Code Review. By default the
132local part of the email address is used.
133.PP
134The URL must match the review URL listed in the manifest XML file, or in the
135\&.git/config within the project. For example:
136.IP
137[remote "origin"]
138.IP
139url = git://git.example.com/project.git
140review = http://review.example.com/
141.IP
142[review "http://review.example.com/"]
143.IP
144autoupload = true
145autocopy = johndoe@company.com,my\-team\-alias@company.com
146.PP
147review.URL.uploadtopic:
148.PP
149To add a topic branch whenever uploading a commit, you can set a per\-project or
150global Git option to do so. If review.URL.uploadtopic is set to "true" then repo
151will assume you always want the equivalent of the \fB\-t\fR option to the repo command.
152If unset or set to "false" then repo will make use of only the command line
153option.
154.PP
155review.URL.uploadhashtags:
156.PP
157To add hashtags whenever uploading a commit, you can set a per\-project or global
158Git option to do so. The value of review.URL.uploadhashtags will be used as
159comma delimited hashtags like the \fB\-\-hashtag\fR option.
160.PP
161review.URL.uploadlabels:
162.PP
163To add labels whenever uploading a commit, you can set a per\-project or global
164Git option to do so. The value of review.URL.uploadlabels will be used as comma
165delimited labels like the \fB\-\-label\fR option.
166.PP
167review.URL.uploadnotify:
168.PP
169Control e\-mail notifications when uploading.
170https://gerrit\-review.googlesource.com/Documentation/user\-upload.html#notify
171.PP
172References
173.PP
174Gerrit Code Review: https://www.gerritcodereview.com/