找回密码
 注册
查看: 220|回复: 2
打印 上一主题 下一主题

Repo:Android 源码管理的利器--工作原理与常用命令全解析

[复制链接]

该用户从未签到

跳转到指定楼层
1#
 楼主| 发表于 2024-10-28 14:58 | 只看该作者 回帖奖励 |倒序浏览 |阅读模式

EDA365欢迎您登录!

您需要 登录 才可以下载或查看,没有帐号?注册

x
本帖最后由 Heaven_1 于 2024-10-28 16:28 编辑 % \( ~" A; t5 y7 {5 h5 z
* H; w7 S+ K5 H, W) M' S0 T
1. 概要

# e: P2 b( C0 X# m9 \: q
repo是Android为了方便管理多个git库而开发的Python脚本。repo的出现,并非为了取代git,而是为了让Android开发者更为有效的利用git。
Android源码包含数百个git库,仅仅是下载这么多git库就是一项繁重的任务,所以在下载源码时,Android就引入了repo。 Android官方推荐下载repo的方法是通过Linux curl命令,下载完后,为repo脚本添加可执行权限:
  1. $ curlhttps://storage.googleapis.com/git-repo-downloads/repo > ( f' K5 i# c6 z( ]8 o
  2. ~/bin/repo7 p# Y: [& \8 v9 [
  3. $ chmod a+x~/bin/repo
复制代码
9 m5 F+ W. K3 C0 M8 ]
由于国内Google访问受限,所以上述命令不一定能下载成功。其实,我们现在可以从很多第三方渠道找到repo脚本,只需要取下来,确保repo可以正确执行即可。
- f. Y8 f7 D; O
2. 工作原理

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

5 a4 i5 i" j# k! S2 u+ k
当打开repo这个可执行的python脚本后,发现代码量并不大(不超过1000行),难道仅这一个脚本就完成了AOSP数百个git库的管理吗?并非如此。 repo是一系列脚本的集合,这些脚本也是通过git库来维护的,这个git库名字叫repo。
; L% {8 j% w! ]3 L; p+ G" O& v
在客户端使用repo初始化一个项目时,就会从远程把manifests和repo这两个git库拷贝到本地,但这对于Android开发人员来说,又是近乎无形的(一般通过文件管理器,是无法看到这两个git库的)。 repo将自动化的管理信息都隐藏根目录的.repo子目录中。

4 C+ `+ \6 Y; z7 A, y8 f- Z
2.1 项目清单库(.repo/manifests)
AOSP项目清单git库下,只有一个文件default.xml,是一个标准的XML,描述了当前repo管理的所有信息。
AOSP的default.xml的文件内容如下:
  1. <?xmlversion="1.0" encoding="UTF-8"?>' u; u! {. b" e* h. C1 G
  2. <manifest>7 U% g5 _0 H! E% Q9 o2 M
  3. <remote name="aosp"4 }  i5 ?4 Z( P+ O  H: a. B
  4. fetch=".."2 V1 H& _& F3 k0 @
  5. review="https://android-review.googlesource.com/" />
    7 M8 u& Z( o7 i6 J, B! z
  6. <default revision="master"
    $ S' _: I% i9 E7 `1 s5 d& x: U$ `
  7. remote="aosp"
    5 ?& |; y; u& c4 U# {
  8. sync-j="4" />
    0 g9 t( I+ V- U* b( @4 @. s" K
  9. <project path="build"name="platform/build" groups="pdk,tradefed" >9 m6 m/ D8 k+ Z/ \
  10. <copyfilesrc="core/root.mk" dest="Makefile" />4 ^5 d( Y5 F4 y
  11. </project>
    9 v( C% [3 a9 K  n% a
  12. <project path="abi/cpp"name="platform/abi/cpp" groups="pdk" />
    ) U7 G6 \$ t+ Z2 \
  13. <project path="art"name="platform/art" groups="pdk" />; B$ W, M# F  O* |) @
  14. ...
    & a* F, S4 v+ Q/ z
  15. <projectpath="tools/studio/translation"name="platform/tools/studio/translation"groups="notdefault,tools" />
    ! s( K; ?6 r4 {4 y: @+ r
  16. <project path="tools/swt"name="platform/tools/swt" groups="notdefault,tools" />
    ' G! V; m6 F+ c8 r6 V
  17. </manifest>
复制代码
0 A5 o4 ]! }' ]* g: n
- l2 D) j0 Y, V
  • :描述了远程仓库的基本信息。name描述的是一个远程仓库的名称,通常我们看到的命名是origin;fetch用作项目名称的前缘,在构造项目仓库远程地址时使用到;review描述的是用作code review的server地址
  • :default标签的定义的属性,将作为标签的默认属性,在标签中,也可以重写这些属性。属性revision表示当前的版本,也就是我们俗称的分支;属性remote描述的是默认使用的远程仓库名称,即标签中name的属性值;属性sync-j表示在同步远程代码时,并发的任务数量,配置高的机器可以将这个值调大
  • :每一个repo管理的git库,就是对应到一个标签,path描述的是项目相对于远程仓库URL的路径,同时将作为对应的git库在本地代码的路径; name用于定义项目名称,命名方式采用的是整个项目URL的相对地址。 譬如,AOSP项目的URL为https://android. googlesource.com/,命名为platform/build的git库,访问的URL就是https ://android.googlesource.com/platform/build, l% C  u) s1 r7 H1 V" F) P( G' {
( e  C8 c- ~& A, F5 U. c7 A
如果需要新增或替换一些git库,可以通过修改default.xml来实现,repo会根据配置信息,自动化管理。但直接对default.xml的定制,可能会导致下一次更新项目清单时,与远程default.xml发生冲突。 因此,repo提供了一个种更为灵活的定制方式local_manifests:所有的定制是遵循default.xml规范的,文件名可以自定义,譬如local_manifest.xml, another_local_manifest.xml等, 将定制的XML放在新建的.repo/local_manifests子目录即可。repo会遍历.repo/local_manifests目录下的所有*.xml文件,最终与default.xml合并成一个总的项目清单文件manifest.xml。
local_manifests的修改示例如下:
  1. $ ls.repo/local_manifests# O* @3 w6 q8 M( d1 r
  2. local_manifest.xml4 O2 O7 k2 A# p* C3 }
  3. another_local_manifest.xml# N' e4 w! F& R. D, l  P$ Q2 ^+ n
  4. 1 @% J) u* V: G2 z
  5. $ cat.repo/local_manifests/local_manifest.xml
    ; r( [8 U* f; i
  6. <?xmlversion="1.0" encoding="UTF-8"?>1 J* [4 _; V3 q$ \' g2 j
  7. <manifest>
    4 p) `- l) w9 \9 Y- U, ?( G
  8. <project path="manifest"name="tools/manifest" />
    & D6 R- I) t& B8 o( W' Y
  9. <projectpath="platform-manifest" name="platform/manifest" />  M4 ^7 V5 J2 Y1 `& @/ x6 x. Y
  10. </manifest>
复制代码

  W8 ~, a$ l; F+ s  Q" U; x  y6 i$ O' r' @
2.2 repo脚本库(.repo/repo)
repo对git命令进行了封装,提供了一套repo的命令集(包括init,sync等),所有repo管理的自动化实现也都包含在这个git库中。 在第一次初始化的时候,repo会从远程把这个git库下载到本地。

6 Z' U% J' f+ P/ [, v
2.3 仓库目录和工作目录
仓库目录保存的是历史信息和修改记录,工作目录保存的是当前版本的信息。一般来说,一个项目的Git仓库目录(默认为.git目录)是位于工作目录下面的,但是Git支持将一个项目的Git仓库目录和工作目录分开来存放。 对于repo管理而言,既有分开存放,也有位于工作目录存放的:
  • manifests: 仓库目录有两份拷贝,一份位于工作目录(.repo/manifests)的.git目录下,另一份独立存放于.repo/manifests.git
  • repo:仓库目录位于工作目录(.repo/repo)的.git目录下
  • project:所有被管理git库的仓库目录都是分开存放的,位于.repo/projects目录下。同时,也会保留工作目录的.git,但里面所有的文件都是到.repo的链接。这样,即做到了分开存放,也兼容了在工作目录下的所有git命令。9 e% g' x* ?5 V0 o
既然.repo目录下保存了项目的所有信息,所有要拷贝一个项目时,只是需要拷贝这个目录就可以了。repo支持从本地已有的.repo中恢复原有的项目。
7 r, n( L  C1 s
2.4 repo 目录结构分析
  • .repo:
    0 ]' e% ^. w% D* `9 b+ U& {
此为repo目录,可用于提取相应项目工作目录到外面的repo工作目录。
  • .repo/manifests.git:& |+ Q4 _  U/ J! O; U: M
此为repo配置信息的git库,不同版本包含不同配置信息。每个repo项目初始化后也会有自己的git仓库的repo也会建立一个Git仓库,用来记录当前Android版本下各个子项目的Git仓库分别处于哪一个分支,这个仓库通常叫做:manifest仓库。
  • .repo/manifests:
    ( M" C7 _4 c0 q0 C; k/ c9 W
此为repo配置信息的工作目录(将配置信息的工作目录和相应的实际git目录分离管理,并且配置信息中的.git目录实际只是指向实际git库的软连接)。此目录中可能包含一个或多个xml文件描述的配置。每个xml文件是独立的一套配置,配置内容包括当前repo工作目录包含哪些git项目、所有git项目所处的默认公共分支、以及远端地址等。
  • .repo/manifest.xml:
    , z8 N( C8 a( H* E2 `
repo工作目录中的内容同一时刻只能采用manifests中的一个xml文件做为其配置,该文件就是其软连接,通过init的-m选项指定采用哪个文件;另外,同一xml文件也可能处于manifests库的不同版本或者不同分支,通过init的-b选项指定使用manifests中的哪个分支,每次init命令都会从服务器更新最新的配置。这里通过-m指定的manifests中的xml文件中。
  • .repo/repo:
    . `" n! N$ ?2 d/ {- y: z1 v) i
此为repo脚本集的git库,用于repo管理所需的各种脚本,repo的所有子命令就是其中的对应脚本实现。这些脚本也通过git管理,.repo/repo/.git为对其应的git目录,用git进行版本管理。
# m! q+ w% T8 Q1 s4 C3 o
3. 使用介绍
  W+ H; K' |! V/ ^) g8 ]# t# [& ^
repo命令的使用格式如下所示:
  1. $ repo <COMMAND> <OPTIONS>
复制代码

5 x8 P" ]. S) x4 T7 [8 ^% _0 n* b  U2 ?" G7 Y8 [9 S
可选的的有:help、init、sync、upload、diff、download、forall、prune、start、status,每一个命令都有实际的使用场景, 下面我们先对这些命令做一个简要的介绍:
' k. A9 T1 Q8 v* Y& p
3.1 init8 s5 E' `, S6 T4 F: [/ `% \% @
  1. $ repo init -u <URL> [<OPTIONS>]
复制代码
0 U5 Z# j) h" J4 A8 L0 y  C+ l; T
2 H( y. Y: V4 l9 M- m* `6 P: [
  • -u:指定manifests这个远程git库的URL,manifests库是整个项目的清单。默认情况,这个git库只包含了default.xml一个文件,其内容可以参见Android的样本
  • -m, –manifest-name:指定所需要的manifests库中的清单文件。默认情况下,会使用maniftests/default.xml
  • -b, –manifest-branch:指定manifest.xml文件中的一个版本,,也就是俗称的“分支”运行该命令后,会在当前目录下新建一个.repo子目录:
    - v4 c1 m( o: y* i' n

9 P& u. h; k2 D
.repo
├── manifests # 一个git库,包含default.xml文件,用于描述repo所管理的git库的信息
├── manifests.git # manifest这个git库的实体,manifest/.git目录下的所有文件都会链接到该目录
├── manifest.xml # manifests/default.xml的一个软链接
├── repo # 一个git库,包含repo运行的所有脚本
这些本地的目录是如何生成的呢?执行repo命令时,可以通过–trace参数,来看实际发生了什么。
  1. $ repo --trace init -u $URL -b $BRANCH -m $MANIFEST9 M. i6 ?8 [- w0 b9 f- Z% \1 [
  2.   --------------------
    ; W( }$ L5 f5 G* E3 m  {; A; f
  3.   mkdir .repo; cd .repo
    * K' z, \9 }/ Z5 Y9 R9 g) t
  4.   git clone --bare $URL manifests.git
    6 P: N6 T' S. v" J, ^
  5.   git clone https://android.googlesource.com/tools/repo
    8 `* e4 T& G! o% c3 t
  6.   mkdir -p manifests/.git; cd manifests/.git! f: C% w0 A, u' ]/ c
  7.   for i in ../../manifests.git/*; do ln -s $ı .; done
    / Z8 d+ L  a2 M8 r
  8.   cd ..
    ! u7 Q; G) I0 E! }
  9.   git checkout $BRANCH -- .8 f6 e0 P% {7 `
  10.   cd ..1 {) l7 T: }& Y/ w' N! j
  11.   ln -s manifests/$MANIFEST manifest.xml
复制代码
$ M4 |0 V+ l+ V; V

' a# a0 x7 a6 _- d* |
首先,在当前目录下创建.repo子目录,后续所有的操作都在.repo子目录下完成;
然后,clone了两个git库,其中一个是-u参数指定的manifests,本地git库的名称是manifest.git;另一个是默认的repo,后面我们会看到这个URL也可以通过参数来指定;
接着,创建了manifest/.git目录,里面的所有文件都是到manifests.git这个目录的链接,这个是为了方便对manifests目录执行git命令,紧接着,就会将manifest切换到-b参数指定的分支;
最后,在.repo目录下,创建了一个软链接,链接到-m参数制定的清单文件,默认情况是manifests/default.xml。
这样,就完成了一个多git库的初始化,之后,就可以执行其他的repo命令了。

! C) j7 L% d( B1 G& Q' x
我们还介绍几个不常用的参数,在国内下载Android源码时,会用到:
+ q7 B5 J8 i; v' M" u: a, C
  • –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库时,可能会导致检查不通过,所以可以配套使用该参数,强制不进行检查# A( N( p4 L1 }# y' h" T! z
" a# h, e6 F9 B% X5 I& I5 p1 v
3.2 sync" m+ b$ l5 T' [
  1. $ repo sync [PROJECT_LIST]
复制代码

) T8 P; v+ J8 c; ^% Q+ f4 O1 z# p/ ?3 T* S' a$ F3 |! S
下载远程代码,并将本地代码更新到最新,这个过程称为“同步”。如果不使用任何参数,那么会对所有repo管理的进行同步操作;也可以PROJECT_LIST参数,指定若干要同步的PROJECT。 根据本地git库代码不同,同步操作会有不同的行为:
8 Z+ W+ Y1 M2 Q' X( [
  • 当本地的git库是第一次触发同步操作时,那么,该命令等价于git clone,会将远程git库直接拷贝到本地
  • 当本地已经触发过同步操作时,那么,该命令等价于git remote update && git rebase origin/,就是当前与本地分支所关联的远程分支 代码合并可能会产生冲突,当冲突出现时,只需要解决完冲突,然后执行git rebase --continue即可。
    4 U! h" F  _, Q' p
当sync命令正确执行完毕后,本地代码就同远程代码保持一致了。在一些场景下,我们会用到sync命令的一些参数:
, A$ P7 T' i4 e. l9 R! k; _
  • -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的U R L / c l o n e . b u n d l e 来初始化本地的 g i t 库, c l o n e . b u n d l e 实际上是远程 g i t 库的镜像,通过 H T T P 直接下载,这会更好的利用网络带宽,加快下载速度。当服务器不能正常响应下载 URL/clone.bundle来初始化本地的git库,clone.bundle实际上是远程git库的镜像,通过HTTP直接下载,这会更好的利用网络带宽,加快下载速度。 当服务器不能正常响应下载URL/clone.bundle来初始化本地的git库,clone.bundle实际上是远程git库的镜像,通过HTTP直接下载,这会更好的利用网络带宽,加快下载速度。当服务器不能正常响应下载URL/clone.bundle,但git又能正常工作时,可以通过该参数,配置不下载$URL/clone.bundle,而是直接通过git下载远程git库3 C# l% t( H/ A% Y- D

' g7 l. a5 x' a3.3 upload
& {0 _; d* W) W  Q3 i2 [
  1. $ repo upload [PROJECT_LIST]
复制代码

$ d+ ^$ F, j2 J/ c* b- e
; U; l6 [* @" `1 ~1 R$ g. q, G2 G
从字面意思理解,upload就是要上传,将本地的代码上传到远程服务器。upload命令首先会找出本地分支从上一次同步操作以来发生的改动,然后会将这些改动生成Patch文件,上传至Gerrit服务器。 如果没有指定PROJECT_LIST,那么upload会找出所有git库的改动;如果某个git库有多个分支,upload会提供一个交互界面,提示选择其中若干个分支进行上传操作。

4 v  g5 n7 J; H7 r4 ^7 A
upload并不会直接将改动合并后远程的git库,而是需要先得到Reviewer批准。Reviewer查看改动内容、决定是否批准合入代码的操作,都是通过Gerrit完成。 Gerrit服务器的地址是在manifests中指定的:打开.repo/manifest.xml,这个XML TAG中的review属性值就是Review服务器的URL:
  1. <remote name="aosp"* ^5 _% @2 ~% Y2 G$ t/ b& r4 T
  2.         fetch=".."
      O2 i3 ^: u6 R
  3.         review="https://android-review.googlesource.com/" />
复制代码

$ D: i8 n' O6 d# N3 u7 e) d; Z8 E
Gerrit的实现机制不是本文讨论的内容,但有几个与Gerrit相关的概念,是需要代码提交人员了解的:

& ^1 z9 g- O: J/ L. F; G8 V
  • 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中,只有最新的一个是真正有用的,能够合并的。
    # D  z, ^, t! q3 g# g# d) `

4 x6 q7 w9 o" N9 r* z0 K3 d, h3.4 download
7 M: ]6 k9 a* A
  1. $ repo download <TARGET> <CHANGE>
复制代码
* Y; U. [3 r* b4 w1 G5 V. I- [0 [) m
; l& M. F: b; r0 T
upload是把改动内容提交到Gerrit,download是从Gerrit下载改动。与upload一样,download命令也是配合Gerrit使用的。

# k# H+ D  z9 m% @' k
  • :指定要下载的PROJECT,譬如platform/frameworks/base, platform/packages/apps/Mms
  • :指定要下载的改动内容。这个值不是Commit-ID,也不是Change-ID,而是一个Review任务URL的最后几位数字。 譬如,AOSP的一个Review任务https: //android-review.googlesource.com/#/c/23823/,其中23823就是。' y  ]% i/ A! h. [. C% h

* L% y) U& k" b( o3.5 forall
5 x$ l& t% `+ a3 V3 B
  1. $ repo forall [PROJECT_LIST] -c <COMMAND>
复制代码

: I* ?: U' p) [' Z0 R5 |
; j/ l6 }, V* z
对指定的git库执行-c参数制定的命令序列。在管理多个git库时,这是一条非常实用的命令。PROJECT_LIST是以空格区分的,譬如:
$ repo forall frameworks/base packages/apps/Mms -c "git status"2 C. G; `3 h) o4 y8 n- [; u
表示对platform/frameworks/base和platform/packages/apps/Mms同时执行git status命令。 如果没有指定PROJECT_LIST,那么,会对repo管理的所有git库都同时执行命令。
8 d* }6 F8 [& @' i
该命令的还有一些其他参数:

5 _" w7 B. q1 }: x8 o: V
  • -r, –regex: 通过指定一个正则表达式,只有匹配的PROJECT,才会执行指定的命令
  • -p:输出结果中,打印PROJECT的名称. u/ ]1 s3 \0 q- |( F2 Z) A

1 [7 p/ }3 q. E. C9 W# l3.6 prune
. c) m3 Y9 J" \/ ]0 B
  1. $ repo prune [<PROJECT_LIST>]
复制代码
) ]* v* Q: n: E  g) H7 I" m

' K' D; u. }0 U0 ~9 k5 }: Q5 S6 ~) B
删除指定PROJECT中,已经合并的分支。当在开发分支上代码已经合并到主干分支后,使用该命令就可以删除这个开发分支。
随着时间的演进,开发分支会越来越多,在多人开发同一个git库,多开发分支的情况会愈发明显,假设当前git库有如下分支:
  1. * master: s8 s  z0 \8 y9 h
  2.   dev_feature1_201501   # 已经合并到master1 u: a2 n8 |6 n) [) N3 \4 A4 X
  3.   dev_feature2_201502   # 已经合并到master
    ; Z* A9 l$ }. m( q; F% y# ?
  4.   dev_feature3_201503   # 正在开发中,还有改动记录没有合并到master
复制代码
4 \& Y9 n; C0 p& S4 Z1 l
那么,针对该git库使用prune命令,会删除dev_feature1_201501和dev_feature2_201502。
定义删除无用的分支,能够提交团队的开发和管理效率。prune就是删除无用分支的”杀手锏“。

3 }# \" r, e$ e1 K, p" C' D1 k3.7start
" t  Q" o  r% }; b; B: |+ K
  1. $ repo start <BRANCH_NAME> [<PROJECT_LIST>]
复制代码

* z+ _& P4 e& {) ~: T) V6 h4 k! Z0 }- q7 `- N  |7 ~0 ~
在指定的PROJECT的上,切换到<BRANCH_NAME>指定的分支。可以使用–all参数对所有的PROJECT都执行分支切换操作。 该命令实际上是对git checkout命令的封装,<BRANCH_NAME>是自定义的,它将追踪manifest中指定的分支名。

; L( |% |' ~; `: P# Z
当第一次sync完代码后,可以通过start命令将git库切换到开发分支,避免在匿名分支上工作导致丢失改动内容的情况。
9 b3 r% Q# Y5 ?$ \! Q. C0 h9 w7 l
3.8 status
# M! W5 e* [6 c# t$ H+ O4 C
  1. $ repo status [<PROJECT_LIST>]
复制代码
. b. d9 o0 _0 }

, a' P7 X6 n9 @/ a3 A
status用于查看多个git库的状态。实际上,是对git status命令的封装。
4. 使用实践" l) R' V: m1 l0 B1 k" k! W" `
Android推荐的开发流程是:
  • repo init初始化工程,指定待下载的分支
  • repo sync下载代码
  • repo start将本地git库切换到开发分支(TOPIC BRANCH)
  • 在本地进行修改,验证后,提交到本地
  • repo upload上传到服务器,等待review5 t- B: ?0 M' u& y
2 z& W3 Q# K( O0 Q' S
在实际使用过程中,我们会用到repo的一些什么子命令和参数呢?哪些参数有助于提高开发效率呢?下面我们以一些实际场景为例展开说明。

$ k" e* P" t( Q0 c/ t2 O4.1 对项目清单文件进行定制
通过local_manifest机制,能够避免了直接修改default.xml,不会造成下次同步远程清单文件的冲突。

3 ^& m; {) Q) r" T" `1 x
CyanogenMod(CM)适配了上百款机型,不同机型所涉及到的git库很可能是有差异的。以CM对清单文件的定制为例,通过新增local_manifest.xml,内容如下:
  1. <manifest>7 U8 ^+ t# t1 L2 J* s
  2.     <!-- add github as a remote source -->
    ' G$ x  O; `- F. n2 E5 D
  3.     <remote name="github" fetch="git://github.com" />
    $ [, d. v$ G" }; e& G

  4. " @  ^) d+ n  l- F
  5. / S4 }8 I( E8 \# U% ^' }1 g
  6.     <!-- remove aosp standard projects and replace with cyanogenmod versions -->4 G8 l2 E2 ?" d: T+ D
  7.     <remove-project name="platform/bootable/recovery" />$ i3 d  }% ]1 y  V  T" y) Z6 y
  8.     <remove-project name="platform/external/yaffs2" />
    2 P' E, x3 S/ d6 O6 i( e( o3 O8 a4 E' z
  9.     <remove-project name="platform/external/zlib" />( ~3 h2 h2 K5 b" W0 c
  10.     <project path="bootable/recovery" name="CyanogenMod/android_bootable_recovery" remote="github" revision="cm-10.1" />9 E2 Q. H3 B( k. o  y+ Z- I
  11. ) a: K  ^9 M' a- T
  12.     <project path="external/yaffs2" name="CyanogenMod/android_external_yaffs2" remote="github" revision="cm-10.1" />
    * P# M. p' l2 q
  13.     <project path="external/zlib" name="CyanogenMod/android_external_zlib" remote="github" revision="cm-10.1" />" P  ~, }3 W- b
  14. * s: g7 P7 h: L. P
  15.     <!-- add busybox from the cyanogenmod repository -->8 X7 t2 K+ h- {* C
  16.     <project path="external/busybox" name="CyanogenMod/android_external_busybox" remote="github" revision="cm-10.1" />
    1 P* Z- B8 l% h4 W' Y7 _
  17.   ~9 u- L  ]4 W0 E; w$ s
  18. & m2 \! N/ y! G
  19. </manifest>
复制代码

( b0 p6 U' V" Y* u" k+ g/ u
local_manifest.xml会与已有的default.xml融合成一个项目清单文件manifest.xml,实现了对一些git库的替换和新增。 可以通过以下命令导出当前的清单文件,最终snapshot.xml就是融合后的版本:
  1. $ repo manifest -o snapshot.xml -r
复制代码
2 U% {" l8 P& Y: N: W" Y
在编译之前,保存整个项目的清单,有助于问题的回溯。当项目的git库发生变更,需要回退到上一个版本进行验证的时候,只需要重新基于snapshot.xml初始化上一个版本即可:
  1. $ cp snapshot.xml .repo/manifests/* \: K/ C% F  w: I
  2. $ repo init -m snapshot.xml         # -m 参数表示自定义manifest# ?6 v6 e$ n9 }* v3 x9 b2 a! p
  3. $ repo sync -d                             # -d 参数表示从当前分支脱离,切换到manifest中定义的分支
复制代码

# R4 W& ]" ^8 p* g0 z- t; u/ V* n0 v3 L0 u4 V, X
4.2 解决无法下载Android源码4 ^2 ~' t! q$ ~- I* b
在repo init的时候,会从远程下载manifests和repo这两个git库,默认情况下,这两个git库的地址都是写死在repo这个python脚本里面的。对于AOSP而言,这两个git库的地址显然是google提供的。但由于google访问受限的缘故,会导致init时,无法下载manifests和repo。这时候,可以使用init的-u和–repo-url参数,自定义这两个库的地址,辅以–no-repo-verify来绕过代码检查。
  1. $ repo init --repo-url [PATH/TO/REPO] -u [PATH/TO/MANIFEST] -b8 k3 O% N! @+ Z, \
  2. [BRANCH] --no-repo-verify1 i; R8 L: J9 M# c; J+ K
  3. $ repo sync
复制代码
7 ~/ J3 S4 O0 G8 S% ]$ t
2 P: H- H& ~' C# n

  o! G: X5 f6 S( L/ K" K4.3 更快更省的下载远程代码
repo默认会同步git库的所有远程分支的代码,但实际开发过程中,用到的分支是有限的。使用sync的-c参数,可以只下载manifest中设定的分支,这会节省代码下载时间以及本地的磁盘空间:
  1. $ repo sync -c
复制代码
) ~. ^( A+ r0 a
如果实际开发过程中,需要用到另外一个分支,而又不想被其他分支干扰,可以在已有的工程根目录下,使用如下命令:
  1. $ repo manifest -o snapshot.xml -r
    3 S5 j; \# h8 g0 k5 O) O4 ^
  2. $ repo init -u [PATH/TO/MANIFEST] -b [ANOTHER_BRANCH]" T5 V, h' X! G6 W6 {& g6 z
  3. $ repo sync -c -d
复制代码
- a( p: y# k2 \0 z

* g8 E" t3 G: |/ ~; i8 t& k
以上命令序列,相当更新了manifest,而且仅仅只下载ANOTHER_BRANCH的代码,这样本地只保存了两个分支的代码。利用保存的snapshot.xml,还能将所有git库方便的切换回原来的分支。
' }7 t: J0 t6 J- Q' ?
如果本地已经有一份Android源码,假设路径为~/android-exsit,想要下载另一份新的Android源码,通过–reference参数,在数分钟以内,就能将代码下载完毕:
  1. $ mkdir ~/android-new && cd ~/android-new$ c+ E. I* o( i- R6 E
  2. $ repo init --reference=~/android-exsit -u [PATH/TO/MANIFEST] -b [BRANCH]8 S" `7 j1 `, m) [) @5 |& A
  3. $ repo sync -c
复制代码

1 a) m: c9 t: @ 4.4 避免在匿名分支上工作
在sync完代码后,所有git库默认都是在一个匿名分支上(no branch),很容易会由于误操作导致丢失代码修改。可以使用如下命令将所有的git库切换到开发分支:
  1. $ repo start BRANCH --all
复制代码
- F! f# I9 r4 C4 ], r6 f9 f% B

* n) ]2 l3 F! y  K* O6 e4.5 使用upload提交代码
开发人员可能同时在多个git库,甚至多个分支上,同时进行修改,针对每个git库单独提交代码是繁琐的。可以使用如下命令,一并提交所有的修改:
  1. $ repo upload
复制代码
+ y7 ^9 [) v' P0 u: y' `! h" Q0 o
不用担心会漏提交或者误提交,upload会提供一个交互界面,开发人员选择需要提交的git库和分支即可。
如果需要省去Gerrit上填写reviewer的操作,可以使用–reviewer参数指定Reviewer的邮箱地址:
  1. $ repo upload --reviewer="R.E.viewer@google.com"
复制代码

" F. R2 D1 r' |( G9 f% h4 S6 h, V9 c/ z2 Q$ f+ h
4.6 定期删除已经合并的开发分支
Git鼓励在修复Bug或者开发新的Feature时,都创建一个新的分支。创建Git分支的代价是很小的,而且速度很快,因此,不用担心创建Git分支的成本,而是尽可能多地使用分支。

( W  l* e+ q' `4 a5 l
随着时间的演进,开发分支会越来越多,而一些已经合并到主干的开发分支是没有存在价值的,可以通过prune命令定期删除无用的开发分支:
  1. $ repo prune [PROJECT_LIST]
复制代码
7 B6 o1 H/ S4 G5 N, w; p* y' e

. ]7 t. ^& P9 N2 @1 m: }6 _9 L4.7 同时操作多个git库
对于部分开发人员而言,同时操作多个git库是常态,如果针对每个git库的操作命令都是相同的,那么可以使用如下命令一次性完成所有操作:
  1. $ repo forall -c "git branch | grep tmp | xargs git branch -D; git branch"
复制代码

5 o& s6 b3 b% H) @' C! D' {1 q. v* f( U' n- J( ^4 K
参数-c指定的命令序列可以很复杂,多条命令只需要用“;”间隔。

  }8 n; d# c: K: @- p" V! D7 Y! ]5 w/ o% r

该用户从未签到

2#
发表于 2024-10-28 16:26 | 只看该作者
程序学习有教程吗

点评

目前还没有哈  详情 回复 发表于 2024-10-29 09:23

该用户从未签到

3#
 楼主| 发表于 2024-10-29 09:23 | 只看该作者

8 m5 Q% R$ z4 C目前还没有哈
( u% Q. }1 a/ G- s" m6 m$ T
您需要登录后才可以回帖 登录 | 注册

本版积分规则

关闭

推荐内容上一条 /1 下一条

EDA365公众号

关于我们|手机版|EDA365电子论坛网 ( 粤ICP备18020198号-1 )

GMT+8, 2025-5-28 22:12 , Processed in 0.093750 second(s), 27 queries , Gzip On.

深圳市墨知创新科技有限公司

地址:深圳市南山区科技生态园2栋A座805 电话:19926409050

快速回复 返回顶部 返回列表