Repo实践指南

Repo介绍

Android 使用 Git 做为代码管理工具，开发了Gerrit进行代码审核以便更好的对代码进行集中式管理，还开发了Repo命令行工具，对Git部分命令封装，将百多个Git库有效的进行组织。

Repo工具下载

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

清单库文件介绍

一个清单库能够包含多个清单文件和多个分支，每一个清单文件和分支都有对应的版本。清单文件以xml格式组织的。举个例子：

repo init -u https://mirrors.tuna.tsinghua.edu.cn/git/AOSP/platform/manifest -b android-11.0.0_r27

<?xml version="1.0" encoding="UTF-8"?>
<manifest>

  <remote  name="aosp"
           fetch=".."
           review="https://android-review.googlesource.com/" />
  <default revision="refs/tags/android-11.0.0_r27"
           remote="aosp"
           sync-j="4" />

  <project path="build/make" name="platform/build" groups="pdk" >
    <copyfile src="core/root.mk" dest="Makefile" />
    <linkfile src="CleanSpec.mk" dest="build/CleanSpec.mk" />
    <linkfile src="buildspec.mk.default" dest="build/buildspec.mk.default" />
    <linkfile src="core" dest="build/core" />
    <linkfile src="envsetup.sh" dest="build/envsetup.sh" />
    <linkfile src="target" dest="build/target" />
    <linkfile src="tools" dest="build/tools" />
  </project>
  <project path="build/blueprint" name="platform/build/blueprint" groups="pdk,tradefed" />
  ...
</manifest>

• remote元素，定义了名为aosp的远程版本库，其库的基址为https://mirrors.tuna.tsinghua.edu.cn/git/AOSP/platform，还定义了代码审核服务器的地址https://android-review.googlesource.com/。固然，还能够定义更多的remote元素。
• default元素，设置各个项目默认远程版本库为aosp，默认的的分支为refs/tags/android-11.0.0_r27。固然各个project元素还能够定义本身的remote和revision覆盖默认的配置。
• project元素，用于定义一个项目，path属性表示在工做区克隆的位置，name属性表示该项目的远程版本库的相对路径。
• project元素的子元素copyfile，定义了项目克隆后的一个附件动做，从src拷贝文件到dest。

repo经常使用指令

repo init (下载repo并克隆manifest)

repo init –u URL [OPTIONS]

• -u:指定一个URL，其链接到一个maniest仓库
• -m:在manifest仓库中选择一个xml文件
• -b:选择一个maniest仓库中的一个特殊的分支

命令repo init 要完成以下操做：

• 完成repo工具的完整下载，执行的repo脚本只是引导程序
• 克隆清单库manifest.git (地址来自于-u 参数)
• 克隆的清单库位于manifest.git中，克隆到本地.repo/manifests。在以前的repo版本中清单.repo/manifest.xml只是符号连接，它指向.repo/manifests/default.xml。在目前的repo版本中清单.repo/manifest.xml是一个实际的文件，经过include的方式引用.repo/manifests/default.xml
• 若是manifests中有多个xml文件，repo init 能够任意选择其中一个，默认选择是default.xml

repo init -u https://mirrors.tuna.tsinghua.edu.cn/git/AOSP/platform/manifest -b android-11.0.0_r27 # 在当前目录出现了.repo文件夹
repo init -u git://172.16.1.31/manifest.git –m android.xml # 选择的是android.xml里面的配置，.repo/manifest.xml便指向.repo/manifests/android.xml

repo sync(下载代码)

repo sync [<project>…]

用于参照清单文件.repo/manifest.xml克隆并同步版本库。若是某个项目版本库尚不存在，则执行repo sync 命令至关于执行git clone，若是项目版本库已经存在，则至关于执行下面的两条指令：

git remote update # 至关于对每个remote源执行了fetch操做
git rebase origin/branch # 针对当前分支的跟踪分支执行rebase操做

repo sync
repo sync platform/build # 也能够选择克隆其中的一个项目

repo start(建立并切换分支)

repo start  <newbranchname> [--all | <project>…]

刚克隆下来的代码是没有分支的,repo start实际是对git checkout –b 命令的封装。为指定的项目或全部项目（若使用—all参数），以清单文件中为设定的分支，建立特性分支。这条指令与git checkout –b 仍是有很大的区别的，git checkout –b 是在当前所在的分支的基础上建立特性分支，而repo start是在清单文件设定分支的基础上建立特性分支。

repo start stable --all # 假设清单文件中设定的分支是gingerbread-exdroid-stable，那么执行以上指令就是对全部项目，在gingerbread-exdroid-stable的基础上建立特性分支stable
repo start stable platform/build platform/bionic # 假设清单文件中设定的分支是gingerbread-exdroid-stable，那么执行以上指令就是对platform/build、platform/bionic项目，在gingerbread-exdroid-stable的基础上建立特性分支stable

repo checkout(切换分支)

repo checkout <branchname>  [<project>…]

其实是对git checkout 命令的封装，但不能带-b参数，因此不能用此命令来建立特性分支。

repo checkout crane-dev 
repo checkout crane-dev  platform/build  platform/bionic

repo branches(查看分支)

repo branches [<project>…]

repo branches 
repo branches platform/build platform/bionic

repo diff(查看工做区文件差别)

repo diff [<project>…]

实际是对git diff 命令的封装,用于分别显示各个项目工做区下的文件差别。

repo diff # 查看全部项目
repo diff platform/build platform/bionic # 只查看其中两个项目

repo stage(把文件添加到index表中)

实际是对git add --interactive命令的封装、用于挑选各个项目工做区中的改动以加入暂存区。

repo stage -i [<project>…]

-i表明git add --interactive命令中的--interactive，给出个界面供用户选择

repo prune(删除已经合并分支)

其实是对git branch –d命令的封装，该命令用于扫面项目的各个分支，并删除已经合并的分支，用法以下：

repo prune [<project>…]

repo abandon(删除指定分支)

其实是对git branch –D 命令的封装，用法以下：

repo abandon <branchname> [<project>…]

repo status(查看文件状态)

其实是对git diff-index、git diff-filse命令的封装，同时显示暂存区的状态和本地文件修改的状态

repo status platform/bionic

以上的实例输出显示了platform/bionic项目分支的修改状态

• 每一个小节的首行显示羡慕名称，以及所在分支的名称
• 第一个字母表示暂存区的文件修改状态
  • -:没有改变
  • A:添加（不在HEAD中，在暂存区中）
  • M：修改（在HEAD中，在暂存区中，内容不一样）
  • D:删除（在HEAD中，不在暂存区）
  • R：重命名（不在HEAD中，在暂存区，路径修改）
  • C：拷贝（不在HEAD中，在暂存区，从其余文件拷贝）
  • T：文件状态改变（在HEAD中，在暂存区，内容相同）
  • U：未合并，须要冲突解决
• 第二个字母表示工做区文件的更改状态
  • -：新/未知（不在暂存区，在工做区）
  • m：修改（在暂存区，在工做区，被修改）
  • d：删除（在暂存区，不在工做区）
• 两个表示状态的字母后面，显示文件名信息。若是有文件重名还会显示改变先后的文件名及文件的类似度

repo remote(设置远程仓库)

repo remote add <remotename>  <url> [<project>…] 
repo remote rm <remotename>  [<project>…]

repo remote add org ssh://172.16.1.31/git_repo # 这个指令是根据xml文件添加的远程分支，方便于向服务器提交代码，执行以后的build目录下看到新的远程分支org
repo remote rm org # 删除远程仓库

repo push

repo push <remotename> [--all |<project>…]

这是新添加的指令，用于向服务器提交代码，repo会本身查询须要向服务器提交的项目并提示用户。

repo push org

repo forall

repo forall [<project>…] –c <command>

迭代器，能够在全部指定的项目中执行同一个shell指令

• -c:后面所带的参数着是shell指令
• -p:在shell指令输出以前列出项目名称
• -v:列出执行shell指令输出的错误信息

additional environment variables:

• REPO_PROJECT:指定项目的名称
• REPO_PATH:指定项目在工做区的相对路径
• REPO_REMOTE:指定项目远程仓库的名称
• REPO_LREV:指定项目最后一次提交服务器仓库对应的哈希值
• REPO_RREV:指定项目在克隆时的指定分支，manifest里的revision属性

另外，若是-c后面所带的shell指令中有上述环境变量，则须要用单引号把shell指令括起来。

添加的环境变量

repo forall –c ‘echo $REPO_PROJECT’
repo forall –c ‘echo $REPO_PATH’

merge(合并多个分支)

把全部项目多切换到master分支，执行如下指令将topic分支合并到master分支

repo forall –p –c git merge topic

tag(打标签)

在全部项目下打标签

repo forall –c git tag crane-stable-1.6

remote (设置远程仓库)

引用环境变量REPO_PROJECT添加远程仓库：

repo forall –c ‘git remote add korg ssh://xiong@172.16.31/$REPO_PROJECT.git’

删除远程仓库：

repo forall –c git remote add korg

branch(建立特性分支)

repo forall –c git branch crane-dev
repo forall –c git checkout –b crane-dev

repo grep

至关于对git grep 的封装，用于在项目文件中进行内容查找

repo manifest

显示manifest文件内容

repo manifest –o android.xml

repo version

显示repo的版本号

repo upload

repo upload至关于git push，可是又有很大的不一样。它不是将版本库改动推送到克隆时的远程服务器，而是推送到代码审核服务器(Gerrit软件架设)的特殊引用上，使用SSH协议。代码审核服务器会对推送的提交进行特殊处理，将新的提交显示为一个待审核的修改集，并进入代码审查流程，只有当审核经过后，才会合并到官方正式的版本库中。

repo upload [--re --cc] {[<project>]… | --replace <project>}

• -h, --help:显示帮助信息
• -t:发送本地分支名称到Gerrit代码审核服务器
• --replace:发送此分支的更新补丁集
• --re=REVIEWERS:要求指定的人员进行审核
• --cc=CC:同时发送通知到以下邮件地址

repo download

主要用于代码审核者下载和评估贡献者提交的修订

repo download {project change [patchset]}…

repo selfupdate

用于repo自身的更新

参考文档

• Repo command reference: https://source.android.com/setup/develop/repo
• repo 下载Android源码（国内镜像）: https://blog.csdn.net/shenlan18446744/article/details/51490560
• repo使用: https://blog.csdn.net/fe421504975/article/details/8272065