diff options
author | Mike Frysinger <vapier@google.com> | 2021-05-04 08:06:36 -0400 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2021-05-04 16:40:53 +0000 |
commit | c177f944d95c460803f8a894fd13d4901c3155fe (patch) | |
tree | 1645c1bcf6e2cd304600ebc1f5193a0edf329429 /subcmds/upload.py | |
parent | aedd1e5ef015fba194681e167edf460c21a1c980 (diff) | |
download | git-repo-c177f944d95c460803f8a894fd13d4901c3155fe.tar.gz |
subcmds: force consistent help text format
We're inconsistent with help text as to whether it uses title case and
whether it ends in a period. Add a test to enforce a standard, and use
the style that Python optparse & argparse use themselves (e.g. with the
--help option): always lowercase, and never trailing period.
Change-Id: Ic1defae23daeac0ac9116aaf487427f50b34050d
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/305144
Reviewed-by: Raman Tenneti <rtenneti@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'subcmds/upload.py')
-rw-r--r-- | subcmds/upload.py | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/subcmds/upload.py b/subcmds/upload.py index c497d877..fc389e42 100644 --- a/subcmds/upload.py +++ b/subcmds/upload.py | |||
@@ -152,61 +152,61 @@ Gerrit Code Review: https://www.gerritcodereview.com/ | |||
152 | def _Options(self, p): | 152 | def _Options(self, p): |
153 | p.add_option('-t', | 153 | p.add_option('-t', |
154 | dest='auto_topic', action='store_true', | 154 | dest='auto_topic', action='store_true', |
155 | help='Send local branch name to Gerrit Code Review') | 155 | help='send local branch name to Gerrit Code Review') |
156 | p.add_option('--hashtag', '--ht', | 156 | p.add_option('--hashtag', '--ht', |
157 | dest='hashtags', action='append', default=[], | 157 | dest='hashtags', action='append', default=[], |
158 | help='Add hashtags (comma delimited) to the review.') | 158 | help='add hashtags (comma delimited) to the review') |
159 | p.add_option('--hashtag-branch', '--htb', | 159 | p.add_option('--hashtag-branch', '--htb', |
160 | action='store_true', | 160 | action='store_true', |
161 | help='Add local branch name as a hashtag.') | 161 | help='add local branch name as a hashtag') |
162 | p.add_option('-l', '--label', | 162 | p.add_option('-l', '--label', |
163 | dest='labels', action='append', default=[], | 163 | dest='labels', action='append', default=[], |
164 | help='Add a label when uploading.') | 164 | help='add a label when uploading') |
165 | p.add_option('--re', '--reviewers', | 165 | p.add_option('--re', '--reviewers', |
166 | type='string', action='append', dest='reviewers', | 166 | type='string', action='append', dest='reviewers', |
167 | help='Request reviews from these people.') | 167 | help='request reviews from these people') |
168 | p.add_option('--cc', | 168 | p.add_option('--cc', |
169 | type='string', action='append', dest='cc', | 169 | type='string', action='append', dest='cc', |
170 | help='Also send email to these email addresses.') | 170 | help='also send email to these email addresses') |
171 | p.add_option('--br', '--branch', | 171 | p.add_option('--br', '--branch', |
172 | type='string', action='store', dest='branch', | 172 | type='string', action='store', dest='branch', |
173 | help='(Local) branch to upload.') | 173 | help='(local) branch to upload') |
174 | p.add_option('-c', '--current-branch', | 174 | p.add_option('-c', '--current-branch', |
175 | dest='current_branch', action='store_true', | 175 | dest='current_branch', action='store_true', |
176 | help='Upload current git branch.') | 176 | help='upload current git branch') |
177 | p.add_option('--no-current-branch', | 177 | p.add_option('--no-current-branch', |
178 | dest='current_branch', action='store_false', | 178 | dest='current_branch', action='store_false', |
179 | help='Upload all git branches.') | 179 | help='upload all git branches') |
180 | # Turn this into a warning & remove this someday. | 180 | # Turn this into a warning & remove this someday. |
181 | p.add_option('--cbr', | 181 | p.add_option('--cbr', |
182 | dest='current_branch', action='store_true', | 182 | dest='current_branch', action='store_true', |
183 | help=optparse.SUPPRESS_HELP) | 183 | help=optparse.SUPPRESS_HELP) |
184 | p.add_option('--ne', '--no-emails', | 184 | p.add_option('--ne', '--no-emails', |
185 | action='store_false', dest='notify', default=True, | 185 | action='store_false', dest='notify', default=True, |
186 | help='If specified, do not send emails on upload.') | 186 | help='do not send e-mails on upload') |
187 | p.add_option('-p', '--private', | 187 | p.add_option('-p', '--private', |
188 | action='store_true', dest='private', default=False, | 188 | action='store_true', dest='private', default=False, |
189 | help='If specified, upload as a private change.') | 189 | help='upload as a private change (deprecated; use --wip)') |
190 | p.add_option('-w', '--wip', | 190 | p.add_option('-w', '--wip', |
191 | action='store_true', dest='wip', default=False, | 191 | action='store_true', dest='wip', default=False, |
192 | help='If specified, upload as a work-in-progress change.') | 192 | help='upload as a work-in-progress change') |
193 | p.add_option('-o', '--push-option', | 193 | p.add_option('-o', '--push-option', |
194 | type='string', action='append', dest='push_options', | 194 | type='string', action='append', dest='push_options', |
195 | default=[], | 195 | default=[], |
196 | help='Additional push options to transmit') | 196 | help='additional push options to transmit') |
197 | p.add_option('-D', '--destination', '--dest', | 197 | p.add_option('-D', '--destination', '--dest', |
198 | type='string', action='store', dest='dest_branch', | 198 | type='string', action='store', dest='dest_branch', |
199 | metavar='BRANCH', | 199 | metavar='BRANCH', |
200 | help='Submit for review on this target branch.') | 200 | help='submit for review on this target branch') |
201 | p.add_option('-n', '--dry-run', | 201 | p.add_option('-n', '--dry-run', |
202 | dest='dryrun', default=False, action='store_true', | 202 | dest='dryrun', default=False, action='store_true', |
203 | help='Do everything except actually upload the CL.') | 203 | help='do everything except actually upload the CL') |
204 | p.add_option('-y', '--yes', | 204 | p.add_option('-y', '--yes', |
205 | default=False, action='store_true', | 205 | default=False, action='store_true', |
206 | help='Answer yes to all safe prompts.') | 206 | help='answer yes to all safe prompts') |
207 | p.add_option('--no-cert-checks', | 207 | p.add_option('--no-cert-checks', |
208 | dest='validate_certs', action='store_false', default=True, | 208 | dest='validate_certs', action='store_false', default=True, |
209 | help='Disable verifying ssl certs (unsafe).') | 209 | help='disable verifying ssl certs (unsafe)') |
210 | RepoHook.AddOptionGroup(p, 'pre-upload') | 210 | RepoHook.AddOptionGroup(p, 'pre-upload') |
211 | 211 | ||
212 | def _SingleBranch(self, opt, branch, people): | 212 | def _SingleBranch(self, opt, branch, people): |