1、repo是什么

repo是Android为方便管理多个git库开发的Python脚本。repo的出现，并非为了取代git，而是为了让Android开发者更有效的利用git。

Android官方推荐下载repo的方法是通过Linux curl命令，下载完成后，为repo脚本添加可执行权限：

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

• UBUNTU上的安装：https://blog.csdn.net/u010117864/article/details/88805136
• https://mirrors.tuna.tsinghua.edu.cn/help/git-repo/
• http://www.cpacm.net/2020/01/06/Git-Repo%E7%9A%84%E4%BD%BF%E7%94%A8/

 2、repo的工作原理

repo需要关注当前git库的数量、名称、路径等，有了这些基本信息，才能对这些git库进行操作。通过集中维护所有git库的清单，repo可以方便的从清单中获取git库的信息。这份清单会随着版本演进升级而产生变化，同时也有一些本地的修改定制需求，所以,repo是通过一个git库来管理项目的清单文件的，这个git库名字叫manifest。

在客户端使用repo初始化一个项目时，就会从远程把manifest和repo这两个git库拷贝到本地，但这对于Android开发人员来说，又是近乎无形的（一般通过文件管理器，是无法看到这两个git库的）。repo将自动化的管理信息都隐藏根目录的.repo子目录中。

• repo项目清单库(.repo/manifests)

AOSP项目清单git库的default.xml

<?xml version="1.0" encoding="UTF-8"?> 
<manifest>
    <remote name="aosp" fetch=".." review="https://android-review.googlesource.com/" /> 
    <default revision="master" remote="aosp" sync-j="4" /> 
    <project path="build" name="platform/build" groups="pdk,tradefed" >
        <copyfile src="core/root.mk" dest="Makefile" /> 
    </project> 
    <project path="abi/cpp" name="platform/abi/cpp" groups="pdk" /> 
    <project path="art" name="platform/art" groups="pdk" /> ... 
    <project path="tools/studio/translation" name="platform/tools/studio/translation" groups="notdefault,tools" /> 
    <project path="tools/swt" name="platform/tools/swt" groups="notdefault,tools" /> 
</manifest> 

 <remote>：描述了远程仓库的基本信息。name描述的是一个远程仓库的名称，通常我们看到的命名是origin;fetch用作项目名称的前缘，在构造项目仓库远程地址时使用到;review描述的是用作code review的server地址

<default>：default标签的定义的属性，将作为<project>标签的默认属性，在<project>标签中，也可以重写这些属性。属性revision表示当前的版本，也就是我们俗称的分支;属性remote描述的是默认使用的远程仓库名称，即<remote>标签中name的属性值;属性sync-j表示在同步远程代码时，并发的任务数量，配置高的机器可以将这个值调大

<project>：每一个repo管理的git库，就是对应到一个<project>标签，path描述的是项目相对于远程仓库URL的路径，同时将作为对应的git库在本地代码的路径; name用于定义项目名称，命名方式采用的是整个项目URL的相对地址。 譬如，AOSP项目的URL为https://android.googlesource.com/，命名为platform/build的git库，访问的URL就是https://android.googlesource.com/platform/build

如果需要新增或替换一些git库，可以通过修改default.xml来实现，repo会根据配置信息，自动化管理。但直接对default.xml的定制，可能会导致下一次更新项目清单时，与远程default.xml发生冲突。 因此，repo提供了一个种更为灵活的定制方式local_manifests:所有的定制是遵循default.xml规范的，文件名可以自定义，譬如localmanifest.xml, anotherlocalmanifest.xml等， 将定制的XML放在新建的.repo/localmanifests子目录即可。repo会遍历.repo/local_manifests目录下的所有*.xml文件，最终与default.xml合并成一个总的项目清单文件manifest.xml。

#local_manifests的修改示例如下：
ls .repo/localmanifests localmanifest.xml anotherlocalmanifest.xml

cat .repo/localmanifests/localmanifest.xml

<?xml version="1.0" encoding="UTF-8"?> 
<manifest> 
    <project path="manifest" name="tools/manifest" />
    <project path="platform-manifest" name="platform/manifest" /> 
</manifest>

repo脚本库(.repo/repo)

repo对git命令进行了封装，提供了一套repo的命令集(包括init, sync等)，所有repo管理的自动化实现也都包含在这个git库中。 在第一次初始化的时候，repo会从远程把这个git库下载到本地。

仓库目录和工作目录

仓库目录保存的是历史信息和修改记录，工作目录保存的是当前版本的信息。一般来说，一个项目的Git仓库目录（默认为.git目录）是位于工作目录下面的，但是Git支持将一个项目的Git仓库目录和工作目录分开来存放。 对于repo管理而言，既有分开存放，也有位于工作目录存放的:

manifests： 仓库目录有两份拷贝，一份位于工作目录(.repo/manifests)的.git目录下，另一份独立存放于.repo/manifests.git

repo：仓库目录位于工作目录(.repo/repo)的.git目录下

project：所有被管理git库的仓库目录都是分开存放的，位于.repo/projects目录下。同时，也会保留工作目录的.git，但里面所有的文件都是到.repo的链接。这样，即做到了分开存放，也兼容了在工作目录下的所有git命令。

既然.repo目录下保存了项目的所有信息，所有要拷贝一个项目时，只是需要拷贝这个目录就可以了。repo支持从本地已有的.repo中恢复原有的项目。

使用介绍

repo命令的使用格式如下：

#可选的的有：help、init、sync、upload、diff、download、forall、prune、start、status，每一个命令都有实际的使用场景
repo <COMMAND> <OPTIONS>

init

repo init -u <URL> [<OPTIONS>]
#-u：指定manifests这个远程git库的URL，manifests库是整个项目的清单。默认情况，这个git库只包含了default.xml一个文件，其内容可以参见Android的样本
#-m， –manifest-name：指定所需要的manifests库中的清单文件。默认情况下，会使用maniftests/default.xml
#-b， –manifest-branch：指定manifest.xml文件中的一个版本，，也就是俗称的“分支”

#运行该命令后，会在当前目录下新建一个.repo子目录：
.repo 
    ├── manifests # 一个git库，包含default.xml文件，用于描述repo所管理的git库的信息 
    ├── manifests.git # manifest这个git库的实体，manifest/.git目录下的所有文件都会链接到该目录 
    ├── manifest.xml # manifests/default.xml的一个软链接 
    └── repo # 一个git库，包含repo运行的所有脚本

#执行repo命令时，可以通过--trace参数，来看实际发生了什么。
repo --trace init -u $URL -b $BRANCH -m $MANIFEST

mkdir .repo; 
cd .repo 
git clone --bare $URL manifests.git 
git clone https://android.googlesource.com/tools/repo 
mkdir -p manifests/.git; 
cd manifests/.git 
for i in ../../manifests.git/*; do 
    ln -s $ı .; 
done 
cd .. 
git checkout $BRANCH -- . 
cd .. 
ln -s manifests/$MANIFEST manifest.xml `

我们还介绍几个不常用的参数，在国内下载Android源码时，会用到：
–repo-url：指定远程repo库的URL，默认情况是https://android.googlesource.com/tools/repo，但国内访问Google受限，会导致这个库无法下载，从而导致repo init失败，所以可以通过该参数指定一个访问不受限的repo地址

–repo-branch：同manifest这个git库一样，repo这个git库也是有版本差异的，可以通过该参数来指定下载repo这个远程git库的特定分支

–no-repo-verify：在下载repo库时，会对repo的源码进行检查。通过–repo-url指定第三方repo库时，可能会导致检查不通过，所以可以配套使用该参数，强制不进行检查

sync

repo sync [PROJECT_LIST]
#当本地的git库是第一次触发同步操作时，那么，该命令等价于git clone，会将远程git库直接拷贝到本地
#当本地已经触发过同步操作时，那么，该命令等价于git remote update && git rebase origin/<BRANCH>，<BRANCH>就是当前与本地分支所关联的远程分支 代码合并可能会产生冲突，当冲突出现时，只需要解决完冲突，然后执行git rebase --continue即可。

#在一些场景下，我们会用到sync命令的一些参数：

#-j：开启多线程同步操作，这会加快sync命令的执行速度。默认情况下，使用4个线程并发进行sync
#-c, –current-branch：只同步指定的远程分支。默认情况下，sync会同步所有的远程分支，当远程分支比较多的时候，下载的代码量就大。使用该参数，可以缩减下载时间，节省本地磁盘空间
#-d, –detach：脱离当前的本地分支，切换到manifest.xml中设定的分支。在实际操作中，这个参数很有用，当我们第一次sync完代码后，往往会切换到dev分支进行开发。如果不带该参数使用sync， 则会触发本地的dev分支与manifest设定的远程分支进行合并，这会很可能会导致sync失败
#-f, –force-broken：当有git库sync失败了，不中断整个同步操作，继续同步其他的git库
#–no-clone-bundle：在向服务器发起请求时，为了做到尽快的响应速度，会用到内容分发网络(CDN, Content Delivery Network)。同步操作也会通过CDN与就近的服务器建立连接， 使用HTTP/HTTPS的$URL/clone.bundle来初始化本地的git库，clone.bundle实际上是远程git库的镜像，通过HTTP直接下载，这会更好的利用网络带宽，加快下载速度。 当服务器不能正常响应下载$URL/clone.bundle，但git又能正常工作时，可以通过该参数，配置不下载$URL/clone.bundle，而是直接通过git下载远程git库

upload

repo upload [PROJECT_LIST]
#upload命令首先会找出本地分支从上一次同步操作以来发生的改动，然后会将这些改动生成Patch文件，上传至Gerrit服务器。 如果没有指定PROJECT_LIST，那么upload会找出所有git库的改动;如果某个git库有多个分支，upload会提供一个交互界面，提示选择其中若干个分支进行上传操作。
#upload并不会直接将改动合并后远程的git库，而是需要先得到Reviewer批准。Reviewer查看改动内容、决定是否批准合入代码的操作，都是通过Gerrit完成。 Gerrit服务器的地址是在manifests中指定的：打开.repo/manifest.xml，<remote>这个XML TAG中的review属性值就是Review服务器的URL:
<remote name="aosp" fetch=".." review="https://android-review.googlesource.com/" />
#Gerrit的实现机制不是本文讨论的内容，但有几个与Gerrit相关的概念，是需要代码提交人员了解的：
#Reviewer：代码审阅人员可以是多个，是需要人为指定的。Gerrit提供网页的操作，可以填选Reviewer。当有多个git库的改动提交时，为了避免在网页上频繁的填选Reviewer这种重复劳动， upload提供了–re, –reviewer参数，在命令行一次性指定Reviewer
#Commit-ID：git为了标识每个提交，引入了Commit-ID，是一个SHA-1值，针对当次提交内容的一个Checksum，可以用于验证提交内容的完整性
#Change-ID：Gerrit针对每一个Review任务，引入了一个Change-ID，每一个提交上传到Gerrit，都会对应到一个Change-ID， 为了区分于Commit-ID，Gerrit设定Change-ID都是以大写字母 “I” 打头的。 Change-ID与Commit-ID并非一一对应的，每一个Commit-ID都会关联到一个Change-ID，但Change-ID可以关联到多个Commit-ID
#Patch-Set：当前需要Review的改动内容。一个Change-ID关联多个Commit-ID，就是通过Patch-Set来表现的，当通过git commit --amend命令修正上一次的提交并上传时， Commit-ID已经发生了变化，但仍可以保持Change-ID不变，这样,在Gerrit原来的Review任务下，就会出现新的Patch-Set。修正多少次，就会出现多少个Patch-Set， 可以理解，只有最后一次修正才是我们想要的结果，所以，在所有的Patch-Set中，只有最新的一个是真正有用的，能够合并的。

download

repo download <TARGET> <CHANGE>
#upload是把改动内容提交到Gerrit，download是从Gerrit下载改动。与upload一样，download命令也是配合Gerrit使用的。
#<TARGET>：指定要下载的PROJECT，譬如platform/frameworks/base, platform/packages/apps/Mms
#<CHANGE>：指定要下载的改动内容。这个值不是Commit-ID，也不是Change-ID，而是一个Review任务URL的最后几位数字。 譬如，AOSP的一个Review任务https://android-review.googlesource.com/#/c/23823/，其中23823就是<CHANGE>。

forall

repo forall [PROJECT_LIST] -c <COMMAND>
#对指定的git库执行-c参数制定的命令序列。在管理多个git库时，这是一条非常实用的命令。PROJECT_LIST是以空格区分的，譬如：
repo forall frameworks/base packages/apps/Mms -c "git status"
#该命令的还有一些其他参数：
#-r, –regex： 通过指定一个正则表达式，只有匹配的PROJECT，才会执行指定的命令
#-p：输出结果中，打印PROJECT的名称

prune

repo prune [<PROJECT_LIST>] 
#删除指定PROJECT中，已经合并的分支。当在开发分支上代码已经合并到主干分支后，使用该命令就可以删除这个开发分支。
#随着时间的演进，开发分支会越来越多，在多人开发同一个git库，多开发分支的情况会愈发明显，假设当前git库有如下分支：
* master 
dev_feature1_201501 # 已经合并到master 
dev_feature2_201502 # 已经合并到master 
dev_feature3_201503 # 正在开发中，还有改动记录没有合并到master
#那么，针对该git库使用prune命令，会删除devfeature1201501和devfeature2201502。
#定义删除无用的分支，能够提交团队的开发和管理效率。prune就是删除无用分支的”杀手锏“。

start

repo start <BRANCH_NAME> [<PROJECT_LIST>]
#在指定的PROJECT的上，切换到<BRANCHNAME>指定的分支。
#可以使用–all参数对所有的PROJECT都执行分支切换操作。 
#该命令实际上是对git checkout命令的封装，<BRANCHNAME>是自定义的，它将追踪manifest中指定的分支名。
#当第一次sync完代码后，可以通过start命令将git库切换到开发分支，避免在匿名分支上工作导致丢失改动内容的情况。

status

repo status [<PROJECT_LIST>]
#status用于查看多个git库的状态。实际上，是对git status命令的封装。

 

3、使用实践

Android推荐的开发流程是：

1. repo init初始化工程，指定待下载的分支
2. repo sync下载代码
3. repo start将本地git库切换到开发分支(TOPIC BRANCH)
4. 在本地进行修改，验证后，提交到本地
5. repo upload上传到服务器，等待review

对项目清单文件进行定制

可以通过以下命令导出当前的清单文件，最终snapshot.xml就是融合后的版本：

repo manifest -o snapshot.xml -r
cp snapshot.xml .repo/manifests/ 
repo init -m snapshot.xml 
# -m 参数表示自定义manifest 
repo sync -d 
# -d 参数表示从当前分支脱离，切换到manifest中定义的分支 

解决无法下载Android源码

由于google访问受限的缘故，会导致init时，无法下载manifests和repo。这时候，可以使用init的-u和–repo-url参数，自定义这两个库的地址，辅以–no-repo-verify来绕过代码检查。

repo init --repo-url [PATH/TO/REPO] -u [PATH/TO/MANIFEST] -b [BRANCH] --no-repo-verify $ repo sync

更快更省的下载远程代码

如果实际开发过程中，需要用到另外一个分支，而又不想被其他分支干扰，可以在已有的工程根目录下，使用如下命令：

repo manifest -o snapshot.xml -r $ repo init -u [PATH/TO/MANIFEST] -b [ANOTHER_BRANCH] $ repo sync -c -d

如果本地已经有一份Android源码，假设路径为~/android-exsit，想要下载另一份新的Android源码，通过–reference参数，在数分钟以内，就能将代码下载完毕：

mkdir ~/android-new && cd ~/android-new $ repo init --reference=~/android-exsit -u [PATH/TO/MANIFEST] -b [BRANCH] $ repo sync -c 

避免在匿名分支上工作

#在sync完代码后，所有git库默认都是在一个匿名分支上(no branch)，很容易会由于误操作导致丢失代码修改。可以使用如下命令将所有的git库切换到开发分支：
repo start BRANCH --all

使用upload提交代码

开发人员可能同时在多个git库，甚至多个分支上，同时进行修改，针对每个git库单独提交代码是繁琐的。可以使用如下命令，一并提交所有的修改：

repo upload

如果需要省去Gerrit上填写reviewer的操作，可以使用–reviewer参数指定Reviewer的邮箱地址：

repo upload --reviewer="[email protected]"

定期删除已经合并的开发分支

开发分支会越来越多，而一些已经合并到主干的开发分支是没有存在价值的，可以通过prune命令定期删除无用的开发分支：

repo prune [PROJECT_LIST]

同时操作多个git库

对于部分开发人员而言，同时操作多个git库是常态，如果针对每个git库的操作命令都是相同的，那么可以使用如下命令一次性完成所有操作:

repo forall -c "git branch | grep tmp | xargs git branch -D; git branch"

参数-c指定的命令序列可以很复杂，多条命令只需要用“;”间隔。

4、参考文献

https://duanqz.github.io/2015-06-25-Intro-to-Repo

https://blog.csdn.net/nwpushuai/article/details/78778602