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