diff options
author | Mike Frysinger <vapier@google.com> | 2020-03-14 14:35:26 -0400 |
---|---|---|
committer | David Pursehouse <dpursehouse@collab.net> | 2020-03-18 00:24:43 +0000 |
commit | 58ac1678e8438fd029a22365741fc57276eda404 (patch) | |
tree | ddadc39f70fa728e5cf75f2220716da42cef4d55 /docs/release-process.md | |
parent | e1111f5710acf16d91975a9ee5e2c9464730becf (diff) | |
download | git-repo-58ac1678e8438fd029a22365741fc57276eda404.tar.gz |
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>
Diffstat (limited to 'docs/release-process.md')
-rw-r--r-- | docs/release-process.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/release-process.md b/docs/release-process.md index 121c3bf1..93a0f3e0 100644 --- a/docs/release-process.md +++ b/docs/release-process.md | |||
@@ -49,11 +49,11 @@ control how repo finds updates: | |||
49 | 49 | ||
50 | * `--repo-url`: This tells repo where to clone the full repo project itself. | 50 | * `--repo-url`: This tells repo where to clone the full repo project itself. |
51 | It defaults to the official project (`REPO_URL` in the launcher script). | 51 | It defaults to the official project (`REPO_URL` in the launcher script). |
52 | * `--repo-branch`: This tells repo which branch to use for the full project. | 52 | * `--repo-rev`: This tells repo which branch to use for the full project. |
53 | It defaults to the `stable` branch (`REPO_REV` in the launcher script). | 53 | It defaults to the `stable` branch (`REPO_REV` in the launcher script). |
54 | 54 | ||
55 | Whenever `repo sync` is run, repo will check to see if an update is available. | 55 | Whenever `repo sync` is run, repo will check to see if an update is available. |
56 | It fetches the latest repo-branch from the repo-url. | 56 | It fetches the latest repo-rev from the repo-url. |
57 | Then it verifies that the latest commit in the branch has a valid signed tag | 57 | Then it verifies that the latest commit in the branch has a valid signed tag |
58 | using `git tag -v` (which uses gpg). | 58 | using `git tag -v` (which uses gpg). |
59 | If the tag is valid, then repo will update its internal checkout to it. | 59 | 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 | |||
91 | create a signed tag using a key registered in repo itself. | 91 | create a signed tag using a key registered in repo itself. |
92 | Typically we just tag the latest version of the `master` branch. | 92 | Typically we just tag the latest version of the `master` branch. |
93 | The tag could be pushed now, but it won't be used by clients normally (since the | 93 | The tag could be pushed now, but it won't be used by clients normally (since the |
94 | default `repo-branch` setting is `stable`). | 94 | default `repo-rev` setting is `stable`). |
95 | This would allow some early testing on systems who explicitly select `master`. | 95 | This would allow some early testing on systems who explicitly select `master`. |
96 | 96 | ||
97 | ### Creating a signed tag | 97 | ### Creating a signed tag |