init: rename --repo-branch to --repo-rev

We refer to this as "revision" in help text, and in REPO_REV envvar,
so rename to --repo-rev to be consistent.  We keep --repo-branch for
backwards compatibility, but as a hidden option.

Bug: https://crbug.com/gerrit/11045
Change-Id: I1ecc282fba32917ed78a63850360c08469db849a
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/259352
Tested-by: Mike Frysinger <vapier@google.com>
Reviewed-by: David Pursehouse <dpursehouse@collab.net>
This commit is contained in:
Mike Frysinger 2020-03-14 14:35:26 -04:00 committed by David Pursehouse
parent e1111f5710
commit 58ac1678e8
5 changed files with 13 additions and 10 deletions

View File

@ -34,7 +34,7 @@ For example, if you want to change the manifest branch, you can simply run
It tracks the git repository at `REPO_URL` using the `REPO_REV` branch. It tracks the git repository at `REPO_URL` using the `REPO_REV` branch.
Those are specified at `repo init` time using the `--repo-url=<REPO_URL>` Those are specified at `repo init` time using the `--repo-url=<REPO_URL>`
and `--repo-branch=<REPO_REV>` options. and `--repo-rev=<REPO_REV>` options.
Any changes made to this directory will usually be automatically discarded Any changes made to this directory will usually be automatically discarded
by repo itself when it checks for updates. If you want to update to the by repo itself when it checks for updates. If you want to update to the

View File

@ -49,11 +49,11 @@ control how repo finds updates:
* `--repo-url`: This tells repo where to clone the full repo project itself. * `--repo-url`: This tells repo where to clone the full repo project itself.
It defaults to the official project (`REPO_URL` in the launcher script). It defaults to the official project (`REPO_URL` in the launcher script).
* `--repo-branch`: This tells repo which branch to use for the full project. * `--repo-rev`: This tells repo which branch to use for the full project.
It defaults to the `stable` branch (`REPO_REV` in the launcher script). It defaults to the `stable` branch (`REPO_REV` in the launcher script).
Whenever `repo sync` is run, repo will check to see if an update is available. Whenever `repo sync` is run, repo will check to see if an update is available.
It fetches the latest repo-branch from the repo-url. It fetches the latest repo-rev from the repo-url.
Then it verifies that the latest commit in the branch has a valid signed tag Then it verifies that the latest commit in the branch has a valid signed tag
using `git tag -v` (which uses gpg). using `git tag -v` (which uses gpg).
If the tag is valid, then repo will update its internal checkout to it. If the tag is valid, then repo will update its internal checkout to it.
@ -91,7 +91,7 @@ When you want to create a new release, you'll need to select a good version and
create a signed tag using a key registered in repo itself. create a signed tag using a key registered in repo itself.
Typically we just tag the latest version of the `master` branch. Typically we just tag the latest version of the `master` branch.
The tag could be pushed now, but it won't be used by clients normally (since the The tag could be pushed now, but it won't be used by clients normally (since the
default `repo-branch` setting is `stable`). default `repo-rev` setting is `stable`).
This would allow some early testing on systems who explicitly select `master`. This would allow some early testing on systems who explicitly select `master`.
### Creating a signed tag ### Creating a signed tag

6
repo
View File

@ -328,8 +328,10 @@ def GetParser(gitc_init=False):
group = parser.add_option_group('repo Version options') group = parser.add_option_group('repo Version options')
group.add_option('--repo-url', metavar='URL', group.add_option('--repo-url', metavar='URL',
help='repo repository location ($REPO_URL)') help='repo repository location ($REPO_URL)')
group.add_option('--repo-branch', metavar='REVISION', group.add_option('--repo-rev', metavar='REV',
help='repo branch or revision ($REPO_REV)') help='repo branch or revision ($REPO_REV)')
group.add_option('--repo-branch', dest='repo_rev',
help=optparse.SUPPRESS_HELP)
group.add_option('--no-repo-verify', group.add_option('--no-repo-verify',
dest='repo_verify', default=True, action='store_false', dest='repo_verify', default=True, action='store_false',
help='do not verify repo source code') help='do not verify repo source code')
@ -473,7 +475,7 @@ def _Init(args, gitc_init=False):
opt.verbose = opt.output_mode is True opt.verbose = opt.output_mode is True
url = opt.repo_url or REPO_URL url = opt.repo_url or REPO_URL
branch = opt.repo_branch or REPO_REV branch = opt.repo_rev or REPO_REV
if branch.startswith('refs/heads/'): if branch.startswith('refs/heads/'):
branch = branch[len('refs/heads/'):] branch = branch[len('refs/heads/'):]

View File

@ -166,9 +166,10 @@ to update the working directory files.
g.add_option('--repo-url', g.add_option('--repo-url',
dest='repo_url', dest='repo_url',
help='repo repository location', metavar='URL') help='repo repository location', metavar='URL')
g.add_option('--repo-branch', g.add_option('--repo-rev', metavar='REV',
dest='repo_branch', help='repo branch or revision')
help='repo branch or revision', metavar='REVISION') g.add_option('--repo-branch', dest='repo_rev',
help=optparse.SUPPRESS_HELP)
g.add_option('--no-repo-verify', g.add_option('--no-repo-verify',
dest='repo_verify', default=True, action='store_false', dest='repo_verify', default=True, action='store_false',
help='do not verify repo source code') help='do not verify repo source code')

View File

@ -850,7 +850,7 @@ later is required to fix a server side protocol bug.
base = rp.GetBranch(cb).merge base = rp.GetBranch(cb).merge
if not base or not base.startswith('refs/heads/'): if not base or not base.startswith('refs/heads/'):
print('warning: repo is not tracking a remote branch, so it will not ' print('warning: repo is not tracking a remote branch, so it will not '
'receive updates; run `repo init --repo-branch=stable` to fix.', 'receive updates; run `repo init --repo-rev=stable` to fix.',
file=sys.stderr) file=sys.stderr)
mp = self.manifest.manifestProject mp = self.manifest.manifestProject