AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

experimental/documentation/gerrit.md: more detail

Browse Source 
NOTRY=true
Change-Id: I386013af35ae2a8b51fa78109ebd89a826334839
Reviewed-on: https://skia-review.googlesource.com/7754
Commit-Queue: Hal Canary <halcanary@google.com>
Reviewed-by: Mike Klein <mtklein@chromium.org>
This commit is contained in:
Hal Canary 2017-01-30 13:18:43 -05:00 committed by Skia Commit-Bot
parent f200a90f3e
commit 96abfc37cc
2 changed files with 84 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
experimental/documentation/gerrit.md
View File

@ -4,11 +4,22 @@ Using Gerrit without git-cl
setup
-----
cd ...skia_source_dir...
The following must be executed within the Skia source repository.
sh experimental/tools/setup-gerrit
This command sets up a Git commit-message hook to add a unique Change-Id to
each commit. Gerrit only accepts changes with a Change-Id and uses it to
identify which review a change applies to.
Take a look at [the setup-gerrit script](../tools/setup-gerrit) for more detail.
curl -Lo "$(git rev-parse --git-dir)/hooks/commit-msg"
'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
chmod +x "$(git rev-parse --git-dir)/hooks/commit-msg"
If you aquired Skia from a mirror (such as github), you need to change the
`origin` remote to point to point to googlesource. Advanvced uses will note
that there is nothing special about the string `origin` and that you could call
this remote anything you want, as long as you use that name for `get push`.
git remote set-url origin 'https://skia.googlesource.com/skia.git'
creating a change
@ -16,24 +27,38 @@ creating a change
1. Create a topic branch
git checkout -b TOPIC
You may want to set a tracking branch at this time with:
git checkout -b TOPIC -t origin/master
2. Make some commits.
2. Make a commit.
echo 1 > whitespace.txt
git commit -a -m 'Change Foo'
echo 2 > whitespace.txt
git commit -a -m 'Change Foo again'
echo FOO >> whitespace.txt
git commit --all --message 'Change Foo'
git log -1
3. Squash the commits:
`git log` should show that a Change-Id line has been added you your commit
message.
git squash-commits
This is only needed if you have more than one commit on your branch.
3. If You have multiple commits in your branch, Gerrit will think you want
multiple changes that depend on each other. If this is not what you want,
you need to squash the commits.
4. Push to Gerrit
git gerrit-push-master
git push origin @:refs/for/master
`@` is shorthand for `HEAD`, introduced in git v1.8.5.
If you want to target a branch other than `master`, that can be specified
here, too. For example:
git push origin @:refs/for/chrome/m57
[Gerrit Upload Documentation](https://gerrit-review.googlesource.com/Documentation/user-upload.html)
updating a change
@ -42,16 +67,59 @@ updating a change
1. Edit your commits more.
echo 3 > whitespace.txt
git amend-head
echo BAR >> whitespace.txt
git commit --all --amend
Changes to the commit message will be sent with the push as well.
2. Re-squash if needed. (Not needed if you only amended your original commit.)
3. Push to Gerrit.
git gerrit-push-master this is a message
git push origin @:refs/for/master
The title of this patchset will be "this is a message".
If you want to set a comment message for this patch set, do this instead:
git push origin @:refs/for/master%m=this_is_the_patch_set_comment_message
The title of this patch set will be "this is the patch set comment message".
scripting
---------
You may want to make git aliases for common tasks:
git config alias.gerrit-push 'push origin @:refs/for/master'
The following alias amends the head without editing the commit message:
git config alias.amend-head 'commit --all --amend --reuse-message=@'
The following shell script will squash all commits on the current branch,
assuming that the branch has an upstream topic branch.
squash_git_branch() {
local MESSAGE="$(git log --format=%B ^@{upstream} @)"
git reset --soft $(git merge-base @ @{upstream})
git commit -m "$MESSAGE" -e
}
This shell script pushes to gerrit and adds a message to a patchset:
gerrit_push_with_message() {
local REMOTE='origin'
local REMOTE_BRANCH='master'
local MESSAGE="$(echo $*|sed 's/[^A-Za-z0-9]/_/g')"
git push "$REMOTE" "@:refs/for/${REMOTE_BRANCH}%m=${MESSAGE}"
}
These shell scripts can be turned into Git aliases with a little hack:
git config alias.squash-branch '!M="$(git log --format=%B ^@{u} @)";git reset --soft $(git merge-base @ @{u});git commit -m "$M" -e'
git config alias.gerrit-push-message '!f(){ git push origin @:refs/for/master%m=$(echo $*|sed "s/[^A-Za-z0-9]/_/g");};f'

44
experimental/tools/setup-gerrit
View File

@ -1,44 +0,0 @@
#! /bin/sh
# Copyright 2017 Google Inc.
#
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
set -x
set -e
cd "$(dirname "$0")/../.."
### Configure the Change-Id commit-msg Git hook
commit_message_path="$(git rev-parse --git-dir)/hooks/commit-msg"
curl -Lo "$commit_message_path" \
'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
chmod +x "$commit_message_path"
### Verify that origin points at the canonical origin, not github
git remote set-url origin 'https://skia.googlesource.com/skia.git'
### Skia uses a linear history, so rebase-on-pull is a good idea
git config branch.autoSetupRebase 'always'
### this alias does the heavy lifting of talking to gerrit
git config alias.gerrit-push-master \
'!f() { git push origin @:refs/for/master%m=$(echo "$*"|sed "s/[^a-zA-Z0-9]/_/g");};f'
### this alias ensures that your branch has ony one commit on it
git config alias.squash-commits \
'!MSG="$(git log --format=%B ^@{u} @)";git reset --soft $(git merge-base @ @{u});git commit -m "$MSG" -e'
### Amend the HEAD head commit without changing the commit message
git config alias.amend-head 'commit --all --amend --reuse-message=@'