Gerrit Code Review

深藏阁楼爱情的钟 2022-12-07 04:23 222阅读 0赞

# **Gerrit Code Review** #

**Gerrit Code Review**  
[https://www.gerritcodereview.com/][https_www.gerritcodereview.com]

**Gerrit Code Review for Git**  
[https://gerrit-documentation.storage.googleapis.com/Documentation/3.2.3/index.html][https_gerrit-documentation.storage.googleapis.com_Documentation_3.2.3_index.html]

**User Guide**  
[https://gerrit-documentation.storage.googleapis.com/Documentation/3.2.3/intro-user.html][https_gerrit-documentation.storage.googleapis.com_Documentation_3.2.3_intro-user.html]

When a commit is pushed for review, Gerrit stores it in a staging area which is a branch in the special `refs/changes/` namespace. Understanding the format of this ref is not required for working with Gerrit, but it is explained below.  
当推送提交进行审查时，Gerrit 将其存储在暂存区域中，该暂存区域是特殊的 `refs/changes/` 名称空间中的一个分支。使用 Gerrit 不需要了解此引用的格式，但下面将对其进行说明。

A change ref has the format `refs/changes/X/Y/Z` where `X` is the last two digits of the change number, `Y` is the entire change number, and `Z` is the patch set. For example, if the change number is 263270, the ref would be `refs/changes/70/263270/2` for the second patch set.  
变更引用的格式为 `refs/changes/X/Y/Z`，其中 `X` 是 change number 的后两位，`Y` 是整个 change number，`Z` 是 patch set 号。例如，如果 change number 为 263270，则第二个 patch set 的 ref 为 `refs/changes/70/263270/2`。

Using the change ref git clients can fetch the corresponding commit, e.g. for local verification.  
使用 change ref git 客户端可以获取相应的提交，例如用于本地验证。

### Fetch Change ###

checkout 到 commit 时的状态，此时分支名为 (`HEAD detached at FETCH_HEAD`)。

$ git fetch https://gerrithost/myProject refs/changes/74/67374/2 && git checkout FETCH_HEAD

The fetch command can be copied from the download commands in the change screen.  
可以从 change screen 中的 download commands 复制 fetch 命令。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXExMTY_size_16_color_FFFFFF_t_70_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXExMTY_size_16_color_FFFFFF_t_70_pic_center 1]

The `refs/for/` prefix is used to map the Gerrit concept of “Pushing for Review” to the git protocol. For the git client it looks like every push goes to the same branch, e.g. `refs/for/master` but in fact for each commit that is pushed to this ref Gerrit creates a new branch under the `refs/changes/` namespace. In addition Gerrit creates an open change.  
`refs/for/` 前缀用于将 Gerrit 概念 `Pushing for Review` 映射到 git 协议。对于 git 客户端，似乎每次推送都转到同一个分支，例如 `refs/for/master`，但是实际上对于每次推送到该 ref 的提交，Gerrit 都会在 `refs/changes/` 命名空间下创建一个新分支。此外，Gerrit 还创建了一个开放的更改。

## Upload a new Patch Set ##

If there is feedback from code review and a change should be improved a new patch set with the reworked code should be uploaded.  
如果有来自代码审查的反馈，并且应改进更改，则应上传带有重新编写的代码的新补丁集。

This is done by amending the commit of the last patch set. If needed this commit can be fetched from Gerrit by using the `fetch` command from the download commands in the change screen.  
这可以通过修改最后一个补丁集的提交来完成。如果需要，可以通过使用 change screen 中的 download commands 中的 `fetch` 命令从 Gerrit 中获取此提交。

It is important that the commit message contains the Change-Id of the change that should be updated as a footer (last paragraph). Normally the commit message already contains the correct Change-Id and the Change-Id is preserved when the commit is amended.  
重要的是，提交消息中包含应作为页脚更新的更改的 Change-Id (最后一段)。通常，提交消息已经包含正确的Change-Id，并且在修改提交时保留了 Change-Id。

### Push Patch Set ###

一个 Patch Set 就是一次 commit，Gerrit 会将其生成一个 branch 暂存。Change 中每提交一个 Patch Set 表示这个 Change 的一个新的版本，自动覆盖前一个 Patch Set。默认情况下，仅最后一个 Patch Set 是有意义的。Code Review 通过时，也仅仅是最后一个 Patch Set 会合并到指定的 branch 中。

// fetch and checkout the change (checkout command copied from change screen)
      // checkout 到 commit 时的状态，此时分支名为 (HEAD detached at FETCH_HEAD)。
      $ git fetch https://gerrithost/myProject refs/changes/74/67374/2 && git checkout FETCH_HEAD
    
      // rework the change
      $ git add <path-of-reworked-file>
      ...
    
      // amend commit
      $ git commit --amend
    
      // push patch set
      $ git push origin HEAD:refs/for/master

Never amend a commit that is already part of a central branch.  
永远不要修改已经属于 central branch 的提交。

Pushing a new patch set triggers email notification to the reviewers.  
推送新补丁集将触发电子邮件通知审阅者。

[https_www.gerritcodereview.com]: https://www.gerritcodereview.com/
[https_gerrit-documentation.storage.googleapis.com_Documentation_3.2.3_index.html]: https://gerrit-documentation.storage.googleapis.com/Documentation/3.2.3/index.html
[https_gerrit-documentation.storage.googleapis.com_Documentation_3.2.3_intro-user.html]: https://gerrit-documentation.storage.googleapis.com/Documentation/3.2.3/intro-user.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXExMTY_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/654854bef70646b6b0253d9a7ba54a6b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5neXExMTY_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/50e179e555df474a82312abd28daae73.png