0%

多仓库管理工具——Repo

Repo 是建立在Git上的一个多仓库管理工具,可以组织多个仓库的上传和下载。Repo是Google用Python脚本写的调用Git的脚本,主要帮助我们管理多个Git存储仓库,将其上传到我们的版本控制系统,并自动执行Android开发工作流程的某些部分。Repo并不是要取代Git,而是为了在Android环境下更加方便的使用Git。下面来看看Repo的具体用法吧!

安装Repo

在安装Repo时,必须先要确保已经安装了Git工具,以及Python2.7+的环境,下面是在Mac下安装的流程:

1、确保主目录下有一个 bin/ 目录,并且该目录包含在路径中:

1
2
mkdir ~/bin
PATH=~/bin:$PATH

2、下载 Repo 工具,并确保它可执行:

1
2
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo

Windows下没有curl工具可以下载,地址是https://curl.se/windows/dl-7.74.0_2/curl-7.74.0_2-win64-mingw.zip。不过也可以直接访问https://storage.googleapis.com/git-repo-downloads/repo网址,直接把内容复制到~/bin/repo效果是一样的。另外如果googleapis.com无法访问的话也可以替换为Github的Repo地址:

1
curl https://raw.githubusercontent.com/esrlabs/git-repo/stable/repo > ~/bin/repo

对于Linux安装过程可以参考https://github.com/esrlabs/git-repo 这个仓库的README其实说得很清楚了。

Repo的背景

使用Repo之前,最好先熟悉Git,关于Git的推荐资料:https://git-scm.com/book/zh/v2。其实Repo最开始是用来管理Android源代码库的,Android 源代码位于由 Google 托管的 Git 代码库中。Git 代码库中包含 Android 源代码的元数据,其中包括与对源代码进行的更改以及更改日期相关的元数据。而且Android版本库众多,版本库太大以及Git不能部分检出,如果所有的东西都放在一个库中,而某个开发团队比较关心可能只是某个小组件或者插件而已,但是却要下载如此庞大的版本库,所以这一切交给了Repo去管理。

那么Repo如何管理多个代码仓库的呢?

Repo的组成

Repo主要包括两部分:Repo引导脚本(Google 称之为Repo launcher)和Repo命令的主体部分。那么Repo仓库究竟有些什么东西呢,在我们初始化Repo仓库之后,会出现一个.repo的文件夹,里面有如下内容:

1
2
3
4
5
6
7
8
9
10
11
changlinzou@mac work % tree .repo -L 1
.repo
├── manifest.xml -> manifests/default.xml
├── manifests
├── manifests.git
├── project-objects
├── project.list
├── projects
└── repo

5 directories, 2 files

当执行 repo init 命令来初始化仓库的时候首先执行的就是Repo的引导脚本,该脚本会到我们指定的地方去下载Manifest 仓库,以及Repo命令主体部分。下载好之后就放在当前目录下面的.repo目录下,其中:

文件夹 用途
manifests 清单文件的仓库
manifests.git 清单文件的Git裸仓库,不带工作区
manifest.xml 这是一个链接文件,指向你的用于初始化工作区的清单文件,即manifests/default.xml
project.list 一个文本文件,里面包含所有项目名字的列表
projects 该文件夹下包含所有git project 的裸仓库,文件夹的层次结构跟工作区的布局一样
repo 这是repo命令的主体,其中也包含最新的repo命令,推荐使用这里面的repo命令

对于Manifests文件相信每一个Android开发中都不陌生,Android项目中Manifests声明了四大组件,就像列出的项目组件的清单一样。所以其实很容易类比,在这里manifests是清单文件的git仓库,这些xml文件中包含了各个git project的名称,检出的reversion,检出到哪个目录等等信息。Repo就是利用这些manifest文件去分别获取各个project,比如这样一个manifest文件:

1
2
3
4
5
6
7
8
9
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<remote name="origin" fetch="https://github.com/" review="https://github.com/" />
<default remote="origin" revision="master" sync-j="4" />
<project name="xxx_projects/first.git" path="xxx" />
<project name="yyy_projects/first.git" path="yyy" />
<project name="zzz_lib/first.git" path="xxx/zzz_lib" />
......
</manifest>

下面是Repo的manifest文件中元素的意义:

元素 详情
manifest元素 xml文件的根元素
remote 元素 可以存在一个或者多个remote元素,remote元素指定了使用repo upload命令的时候,会将改变提交到哪个服务器
default 元素 default元素中指定的属性都是一些缺省的属性。即如果project元素中不存在该属性,则使用在default元素中指定的属性。revision:Git分支的名字。如果project元素没有指定revision属性,那么就使用default元素的该属性。revision 属性的值可以是一个git branch,git tag,也可以是一个commit id。sync-j:sync的时候,并行工作的任务数。sync-c:如果设置为true,则在同步代码的时候,将只会同步project元素中revision属性中指定的分支。如果project元素没有指定revision属性,则使用default元素的revision属性。
project 元素 xml文件中可以指定一个或者多个project元素。 每一个project元素都描述了一个需要pull到本地的git仓库。project元素中有很多可以使用的属性,在此只介绍几个我们经常使用的属性。name:git project的名字,path:该project的本地工作区的路径,revision:该project要跟踪的分支的名字。名字可以是相对于refs/heads命名空间的,如:master,或者绝对的,如:refs/heads/master。标签或者48位的SHA-1值理论上也可以工作。如果没有提供该属性,则使用default元素中的revision属性。

Repo命令

下面的内容来自Google的官方文档:https://source.android.com/source/using-repo.html

使用 Repo 需遵循的格式如下:

1
repo <COMMAND> <OPTIONS>

可选元素显示在方括号 [ ] 中。例如,许多命令会将项目列表用作参数。您可以为项目指定项目列表,作为名称列表或本地源代码目录的路径列表:

1
2
repo sync [<PROJECT0> <PROJECT1> <PROJECTN>]
repo sync [</PATH/TO/PROJECT0> ... </PATH/TO/PROJECTN>]

help

安装 Repo 后,您可以通过运行以下命令找到最新文档(开头是包含所有命令的摘要):

1
repo help

您可以通过在 Repo 树中运行以下命令来获取有关某个命令的信息:

1
repo help <COMMAND>

例如,以下命令会生成 Repo init 参数的说明和选项列表,该参数会在当前目录中初始化 Repo。(要了解详情,请参阅 init。)

1
repo help init

init

1
$ repo init -u <URL> [<OPTIONS>]

在当前目录中安装 Repo。这会创建一个 .repo/ 目录,其中包含用于 Repo 源代码和标准 Android 清单文件的 Git 代码库。该 .repo/ 目录中还包含 manifest.xml,这是一个指向 .repo/manifests/ 目录中所选清单的符号链接。

选项:

  • -u:指定要从中检索清单代码库的网址。您可以在 https://android.googlesource.com/platform/manifest 中找到常见清单
  • -m:在代码库中选择清单文件。如果未选择任何清单名称,则会默认选择 default.xml。
  • -b:指定修订版本,即特定的清单分支。

注意:对于其余的所有 Repo 命令,当前工作目录必须是 .repo/ 的父目录或相应父目录的子目录。

sync

1
repo sync [<PROJECT_LIST>]

下载新的更改并更新本地环境中的工作文件。如果您在未使用任何参数的情况下运行 repo sync,则该操作会同步所有项目的文件。

运行 repo sync 后,将出现以下情况:

  • 如果目标项目从未同步过,则 repo sync 相当于 git clone。远程代码库中的所有分支都会复制到本地项目目录中。

  • 如果目标项目已同步过,则 repo sync 相当于以下命令:

1
2
git remote update
git rebase origin/<BRANCH>

其中 *<BRANCH>* 是本地项目目录中当前已检出的分支。如果本地分支没有在跟踪远程代码库中的分支,则相应项目不会发生任何同步。

  • 如果 git rebase 操作导致合并冲突,那么您需要使用普通 Git 命令(例如 git rebase --continue)来解决冲突。

repo sync 运行成功后,指定项目中的代码会与远程代码库中的代码保持同步。

选项:

  • -d:将指定项目切换回清单修订版本。如果项目当前属于某个主题分支,但只是临时需要清单修订版本,则此选项会有所帮助。
  • -s:同步到当前清单中清单服务器元素指定的一个已知的良好版本。
  • -f:即使某个项目同步失败,系统也会继续同步其他项目。

upload

1
repo upload [<PROJECT_LIST>]

对于指定的项目,Repo 会将本地分支与最后一次 repo sync 时更新的远程分支进行比较。Repo 会提示您选择一个或多个尚未上传以供审核的分支。

您选择一个或多个分支后,所选分支上的所有提交都会通过 HTTPS 连接传输到 Gerrit。您需要配置一个 HTTPS 密码以启用上传授权。要生成新的用户名/密码对以用于 HTTPS 传输,请访问密码生成器

当 Gerrit 通过其服务器接收对象数据时,它会将每项提交转变成一项更改,以便审核者可以单独针对每项提交给出意见。要将几项“检查点”提交合并为一项提交,请使用 git rebase -i,然后再运行 repo upload。

如果您在未使用任何参数的情况下运行 repo upload,则该操作会搜索所有项目中的更改以进行上传。

要在更改上传之后对其进行修改,您应该使用 git rebase -igit commit --amend 等工具更新您的本地提交。修改完成之后,请执行以下操作:

  • 进行核对以确保更新后的分支是当前已检出的分支。

  • 对于相应系列中的每项提交,请在方括号内输入 Gerrit 更改 ID:

1
2
3
4
5
# Replacing from branch foo
[ 3021 ] 35f2596c Refactor part of GetUploadableBranches to lookup one specific...
[ 2829 ] ec18b4ba Update proto client to support patch set replacments
# Insert change numbers in the brackets to add a new patch set.
# To create a new change record, leave the brackets empty.

上传完成后,这些更改将拥有一个额外的补丁程序集。

diff

1
repo diff [<PROJECT_LIST>]

使用 git diff 显示提交与工作树之间的明显更改。

download

1
repo download <TARGET> <CHANGE>

从审核系统中下载指定更改,并放在您项目的本地工作目录中供使用。

例如,要将更改 23823 下载到您的平台/编译目录,请运行以下命令:

1
$ repo download platform/build 23823

repo sync 应该可以有效移除通过 repo download 检索到的任何提交。或者,您可以将远程分支检出,例如 git checkout m/master

注意:由于全球的所有服务器均存在复制延迟,因此某项更改(位于 Gerrit 中)出现在网络上的时间与所有用户可通过 repo download 找到此项更改的时间之间存在些许的镜像延迟。

forall

1
repo forall [<PROJECT_LIST>] -c <COMMAND>

在每个项目中运行指定的 shell 命令。通过 repo forall 可使用下列额外的环境变量:

  • REPO_PROJECT 可设为项目的具有唯一性的名称。
  • REPO_PATH 是客户端根目录的相对路径。
  • REPO_REMOTE 是清单中远程系统的名称。
  • REPO_LREV 是清单中修订版本的名称,已转换为本地跟踪分支。如果您需要将清单修订版本传递到某个本地运行的 Git 命令,则可使用此变量。
  • REPO_RREV 是清单中修订版本的名称,与清单中显示的名称完全一致。

选项:

  • -c:要运行的命令和参数。此命令会通过 /bin/sh 进行求值,它之后的任何参数都将作为 shell 位置参数传递。
  • -p:在指定命令输出结果之前显示项目标头。这通过以下方式实现:将管道绑定到命令的 stdin、stdout 和 sterr 流,然后通过管道将所有输出结果传输到一个页面调度会话中显示的连续流中。
  • -v:显示该命令向 stderr 写入的消息。

prune

1
repo prune [<PROJECT_LIST>]

删减(删除)已合并的主题。

start

1
repo start <BRANCH_NAME> [<PROJECT_LIST>]

从清单中指定的修订版本开始,创建一个新的分支进行开发。

*<BRANCH_NAME>* 参数应简要说明您尝试对项目进行的更改。如果您不知道,则不妨考虑使用默认名称。

*<PROJECT_LIST>* 指定了将参与此主题分支的项目。

注意:“.”是一个非常实用的简写形式,用来代表当前工作目录中的项目。

status

1
repo status [<PROJECT_LIST>]

对于每个指定的项目,将工作树与临时区域(索引)以及此分支 (HEAD) 上的最近一次提交进行比较。在这三种状态存在差异之处显示每个文件的摘要行。

要仅查看当前分支的状态,请运行 repo status。系统会按项目列出状态信息。对于项目中的每个文件,系统使用两个字母的代码来表示:

在第一列中,大写字母表示临时区域与上次提交状态之间的不同之处。

字母 含义 说明
- 无更改 HEAD 与索引中相同
A 已添加 不存在于 HEAD 中,但存在于索引中
M 已修改 存在于 HEAD 中,但索引中的文件已修改
D 已删除 存在于 HEAD 中,但不存在于索引中
R 已重命名 不存在于 HEAD 中,但索引中的文件的路径已更改
C 已复制 不存在于 HEAD 中,已从索引中的另一个文件复制
T 模式已更改 HEAD 与索引中的内容相同,但模式已更改
U 未合并 HEAD 与索引之间存在冲突;需要解决方案

在第二列中,小写字母表示工作目录与索引之间的不同之处。

字母 含义 说明
- 新/未知 不存在于索引中,但存在于工作树中
m 已修改 存在于索引中,也存在于工作树中(但已修改)
d 已删除 存在于索引中,不存在于工作树中

参考资料

1、https://source.android.com/source/using-repo

2、https://git-scm.com/book/zh/v2

  • 本文作者: Tim
  • 本文链接: https://zouchanglin.cn/4221524257.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!