EDA365欢迎您登录!
您需要 登录 才可以下载或查看,没有帐号?注册
x
本帖最后由 Heaven_1 于 2024-10-28 16:28 编辑 / ?7 V4 s7 h3 A- V! A* P
( o3 o4 b2 N) @9 ~# R1. 概要
' J' o4 _ J# F& }1 f- Urepo是Android为了方便管理多个git库而开发的Python脚本。repo的出现,并非为了取代git,而是为了让Android开发者更为有效的利用git。 Android源码包含数百个git库,仅仅是下载这么多git库就是一项繁重的任务,所以在下载源码时,Android就引入了repo。 Android官方推荐下载repo的方法是通过Linux curl命令,下载完后,为repo脚本添加可执行权限: - $ curlhttps://storage.googleapis.com/git-repo-downloads/repo >
9 c' I; e5 O5 b - ~/bin/repo+ @7 ?' L1 e8 W* n
- $ chmod a+x~/bin/repo
复制代码 1 |6 G* r U5 u( k" y7 @
由于国内Google访问受限,所以上述命令不一定能下载成功。其实,我们现在可以从很多第三方渠道找到repo脚本,只需要取下来,确保repo可以正确执行即可。
" c5 y' c7 \0 o7 a3 M2. 工作原理 1 s5 e/ C: l4 d, |' ~5 L A
repo需要关注当前git库的数量、名称、路径等,有了这些基本信息,才能对这些git库进行操作。通过集中维护所有git库的清单,repo可以方便的从清单中获取git库的信息。 这份清单会随着版本演进升级而产生变化,同时也有一些本地的修改定制需求,所以,repo是通过一个git库来管理项目的清单文件的,这个git库名字叫manifests。 ( n4 O) c8 b' R5 M2 X
当打开repo这个可执行的python脚本后,发现代码量并不大(不超过1000行),难道仅这一个脚本就完成了AOSP数百个git库的管理吗?并非如此。 repo是一系列脚本的集合,这些脚本也是通过git库来维护的,这个git库名字叫repo。 5 D% p S: p4 t; u, V# m7 P
在客户端使用repo初始化一个项目时,就会从远程把manifests和repo这两个git库拷贝到本地,但这对于Android开发人员来说,又是近乎无形的(一般通过文件管理器,是无法看到这两个git库的)。 repo将自动化的管理信息都隐藏根目录的.repo子目录中。 ( @- S8 o" h6 x- S3 t! w" F
2.1 项目清单库(.repo/manifests) AOSP项目清单git库下,只有一个文件default.xml,是一个标准的XML,描述了当前repo管理的所有信息。 AOSP的default.xml的文件内容如下: - <?xmlversion="1.0" encoding="UTF-8"?>
) F9 H% L |+ }$ P6 D* | - <manifest>- q' X4 E% K- B
- <remote name="aosp"" {' e1 X0 W3 w7 P
- fetch=".."" ?# ^1 T1 ~' L/ h9 J4 h8 X# S
- review="https://android-review.googlesource.com/" />
6 g/ w! r+ `6 Z! v0 x& A - <default revision="master"6 W: V5 _3 Y; a- K- e( B, Q
- remote="aosp"
6 t0 \6 |7 P( j7 d - sync-j="4" />
2 g9 W. v1 p; Y" `) l$ J - <project path="build"name="platform/build" groups="pdk,tradefed" >1 o' U# z! j, @3 e
- <copyfilesrc="core/root.mk" dest="Makefile" />. J+ f3 r0 x8 Z! v
- </project> G3 J0 a# r; M1 n5 r7 P5 A
- <project path="abi/cpp"name="platform/abi/cpp" groups="pdk" />
2 P5 }$ t& u7 s - <project path="art"name="platform/art" groups="pdk" />
# Z/ r! o1 C- q' B. c9 w$ P0 w. j' V/ S - ...
' G; _! q+ `3 v/ k: a+ \) n - <projectpath="tools/studio/translation"name="platform/tools/studio/translation"groups="notdefault,tools" />
: C0 r) N0 C6 D; U$ c6 S' u1 {$ t - <project path="tools/swt"name="platform/tools/swt" groups="notdefault,tools" /> B$ F o7 B' }. J; M
- </manifest>
复制代码
5 G9 v+ G5 Q: @6 A8 p9 h5 u: E7 a! @$ R1 V1 H
- :描述了远程仓库的基本信息。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/build7 v: ~6 q- s& M9 C" b' l9 _
7 C0 V7 k) U- c- J1 N& }如果需要新增或替换一些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的修改示例如下: - $ ls.repo/local_manifests
' R E7 V& T4 c+ H* R s' n; n - local_manifest.xml z: M* e# z3 l3 [( ~) X
- another_local_manifest.xml6 ^. _9 y; Z; Q2 U. |
, U9 t5 u, ]4 v' C+ Z" q2 L8 Q- $ cat.repo/local_manifests/local_manifest.xml% `# X; Q# m2 _* C# [: t% @
- <?xmlversion="1.0" encoding="UTF-8"?>) s8 u) X0 g1 W1 J% }
- <manifest>- i: g8 D# E$ ~0 N E A4 \' c1 M
- <project path="manifest"name="tools/manifest" />
2 m. g! J1 H' z' @. @/ t - <projectpath="platform-manifest" name="platform/manifest" />1 u) u5 p, G( x) n' j( a, ^; ?7 y: ]
- </manifest>
复制代码 $ |6 ^3 G) t/ B/ v6 e8 i5 Z
- X; Z1 G# r# T. ^ s
2.2 repo脚本库(.repo/repo) repo对git命令进行了封装,提供了一套repo的命令集(包括init,sync等),所有repo管理的自动化实现也都包含在这个git库中。 在第一次初始化的时候,repo会从远程把这个git库下载到本地。
Y9 Y! k. o3 t! ^# W0 Y/ N2.3 仓库目录和工作目录 仓库目录保存的是历史信息和修改记录,工作目录保存的是当前版本的信息。一般来说,一个项目的Git仓库目录(默认为.git目录)是位于工作目录下面的,但是Git支持将一个项目的Git仓库目录和工作目录分开来存放。 对于repo管理而言,既有分开存放,也有位于工作目录存放的: - manifests: 仓库目录有两份拷贝,一份位于工作目录(.repo/manifests)的.git目录下,另一份独立存放于.repo/manifests.git
- repo:仓库目录位于工作目录(.repo/repo)的.git目录下
- project:所有被管理git库的仓库目录都是分开存放的,位于.repo/projects目录下。同时,也会保留工作目录的.git,但里面所有的文件都是到.repo的链接。这样,即做到了分开存放,也兼容了在工作目录下的所有git命令。& l% I0 \& S( P! T& \3 T/ W
既然.repo目录下保存了项目的所有信息,所有要拷贝一个项目时,只是需要拷贝这个目录就可以了。repo支持从本地已有的.repo中恢复原有的项目。
7 D! `: Z% @$ Y h/ E! F2.4 repo 目录结构分析 - .repo:
7 K; ^( ^$ u4 q! f
此为repo目录,可用于提取相应项目工作目录到外面的repo工作目录。 - .repo/manifests.git:% [, G1 b; \3 Z; J1 g
此为repo配置信息的git库,不同版本包含不同配置信息。每个repo项目初始化后也会有自己的git仓库的repo也会建立一个Git仓库,用来记录当前Android版本下各个子项目的Git仓库分别处于哪一个分支,这个仓库通常叫做:manifest仓库。 - .repo/manifests:
7 ~' u" W6 i# ~3 Y1 u- Y+ i: J
此为repo配置信息的工作目录(将配置信息的工作目录和相应的实际git目录分离管理,并且配置信息中的.git目录实际只是指向实际git库的软连接)。此目录中可能包含一个或多个xml文件描述的配置。每个xml文件是独立的一套配置,配置内容包括当前repo工作目录包含哪些git项目、所有git项目所处的默认公共分支、以及远端地址等。 - .repo/manifest.xml:- m( E, B* N1 f0 z* O( R1 _: A
repo工作目录中的内容同一时刻只能采用manifests中的一个xml文件做为其配置,该文件就是其软连接,通过init的-m选项指定采用哪个文件;另外,同一xml文件也可能处于manifests库的不同版本或者不同分支,通过init的-b选项指定使用manifests中的哪个分支,每次init命令都会从服务器更新最新的配置。这里通过-m指定的manifests中的xml文件中。 - .repo/repo:5 S* c1 v( R5 {: n/ l u
此为repo脚本集的git库,用于repo管理所需的各种脚本,repo的所有子命令就是其中的对应脚本实现。这些脚本也通过git管理,.repo/repo/.git为对其应的git目录,用git进行版本管理。 3 y+ j) J0 V- H+ s' p
3. 使用介绍
( b, u! J; |6 M3 y* `9 arepo命令的使用格式如下所示: - $ repo <COMMAND> <OPTIONS>
复制代码 9 V' l& Y7 S5 Y4 E e
7 h7 H' ~% O- a+ n: M5 J, A4 n可选的的有:help、init、sync、upload、diff、download、forall、prune、start、status,每一个命令都有实际的使用场景, 下面我们先对这些命令做一个简要的介绍:
; k# z2 c9 m' b# ? A5 k. [; l5 G3.1 init
' l+ x( E7 l2 ]4 ]/ f- C- $ repo init -u <URL> [<OPTIONS>]
复制代码
; r1 D4 D+ }' l
) g( P; C, o; X) m* e7 L- -u:指定manifests这个远程git库的URL,manifests库是整个项目的清单。默认情况,这个git库只包含了default.xml一个文件,其内容可以参见Android的样本
- -m, –manifest-name:指定所需要的manifests库中的清单文件。默认情况下,会使用maniftests/default.xml
- -b, –manifest-branch:指定manifest.xml文件中的一个版本,,也就是俗称的“分支”运行该命令后,会在当前目录下新建一个.repo子目录:
% J( t( E9 j& R' N/ b/ P% m
1 F! Q6 f# r/ p& T, H.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
* k+ U. g' d b1 v S3 s4 v - --------------------# K7 J2 i, a! h# D
- mkdir .repo; cd .repo
7 f" {) I7 I; o! c# t* @5 X" z - git clone --bare $URL manifests.git& b. I, }* e$ g) K$ x
- git clone https://android.googlesource.com/tools/repo
7 o# P! T7 Y: n: n2 }5 B1 ~4 D/ `2 k - mkdir -p manifests/.git; cd manifests/.git+ E4 w$ y8 o7 u5 m' A8 G
- for i in ../../manifests.git/*; do ln -s $ı .; done
* C$ z/ Z' q$ R0 H' g4 L - cd ..& C: z1 H3 g. _$ C
- git checkout $BRANCH -- .9 f8 H7 f+ ?+ @7 G
- cd ../ A- K- a6 ~: Z( P/ ^: X& c: w2 C
- ln -s manifests/$MANIFEST manifest.xml
复制代码
; b' s* t( N$ |3 d/ R
3 W+ \8 W% z H7 h首先,在当前目录下创建.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命令了。 ( t. p" [ p7 V3 K
我们还介绍几个不常用的参数,在国内下载Android源码时,会用到: 2 w. e) ?8 a6 Q) l8 u5 B
- –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库时,可能会导致检查不通过,所以可以配套使用该参数,强制不进行检查. O3 H* G2 u) |- E
- D! n4 ~! m: W# B( ^, o; S
3.2 sync: M5 a. E9 D4 I* ]) X6 n
- $ repo sync [PROJECT_LIST]
复制代码
: B5 S) z, l: S. D6 I! n5 P1 z2 {; j* ~. N* V! A
下载远程代码,并将本地代码更新到最新,这个过程称为“同步”。如果不使用任何参数,那么会对所有repo管理的进行同步操作;也可以PROJECT_LIST参数,指定若干要同步的PROJECT。 根据本地git库代码不同,同步操作会有不同的行为: ( l& y& i& B2 l5 w f
- 当本地的git库是第一次触发同步操作时,那么,该命令等价于git clone,会将远程git库直接拷贝到本地
- 当本地已经触发过同步操作时,那么,该命令等价于git remote update && git rebase origin/,就是当前与本地分支所关联的远程分支 代码合并可能会产生冲突,当冲突出现时,只需要解决完冲突,然后执行git rebase --continue即可。
1 H4 s* x3 m3 d$ }5 J" D
当sync命令正确执行完毕后,本地代码就同远程代码保持一致了。在一些场景下,我们会用到sync命令的一些参数:
: A4 O% H$ p! S1 w* `/ B# E( m5 Q- -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库, U" v$ C2 G' Y3 K5 l
0 E6 b& W5 _1 a3.3 upload* W# ?8 M) r9 B3 @& ~; q- i
- $ repo upload [PROJECT_LIST]
复制代码
# C" x( X! e6 Q) ?0 \- }6 M, y n+ Z; y" [) z: `6 j
从字面意思理解,upload就是要上传,将本地的代码上传到远程服务器。upload命令首先会找出本地分支从上一次同步操作以来发生的改动,然后会将这些改动生成Patch文件,上传至Gerrit服务器。 如果没有指定PROJECT_LIST,那么upload会找出所有git库的改动;如果某个git库有多个分支,upload会提供一个交互界面,提示选择其中若干个分支进行上传操作。 ) P: T- ?$ g7 _: t$ @: d4 ?1 h
upload并不会直接将改动合并后远程的git库,而是需要先得到Reviewer批准。Reviewer查看改动内容、决定是否批准合入代码的操作,都是通过Gerrit完成。 Gerrit服务器的地址是在manifests中指定的:打开.repo/manifest.xml,这个XML TAG中的review属性值就是Review服务器的URL: - <remote name="aosp"/ \* ]+ K; R$ B1 w. X3 \
- fetch=".."
* T* J3 ^+ { a) `# d2 W$ j - review="https://android-review.googlesource.com/" />
复制代码
6 }/ N& b; U3 \2 ^- z6 f2 a' ^% t( VGerrit的实现机制不是本文讨论的内容,但有几个与Gerrit相关的概念,是需要代码提交人员了解的:
1 [( ^" ]+ h- i# Y/ a, d- 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中,只有最新的一个是真正有用的,能够合并的。
% v1 r+ C0 Z Q8 I0 ~& T 0 D" B' o5 H) ]
3.4 download3 j6 ]2 d' C2 e' G# k' K
- $ repo download <TARGET> <CHANGE>
复制代码 c6 I# p [3 v
' T/ [9 S( j6 C! bupload是把改动内容提交到Gerrit,download是从Gerrit下载改动。与upload一样,download命令也是配合Gerrit使用的。
9 W+ ]5 @. e- @/ {! }# ?- :指定要下载的PROJECT,譬如platform/frameworks/base, platform/packages/apps/Mms
- :指定要下载的改动内容。这个值不是Commit-ID,也不是Change-ID,而是一个Review任务URL的最后几位数字。 譬如,AOSP的一个Review任务https: //android-review.googlesource.com/#/c/23823/,其中23823就是。
6 n- |2 u) O: @( s5 ~; K
* i) x4 J5 E+ [0 I0 H7 J7 C) M3.5 forall
9 S" P* ?$ p; t& S& ~7 }8 h- $ repo forall [PROJECT_LIST] -c <COMMAND>
复制代码
) t5 ?- }3 X8 J$ _/ E/ s+ D) Q6 r' \) x/ c2 l1 c4 X* f
对指定的git库执行-c参数制定的命令序列。在管理多个git库时,这是一条非常实用的命令。PROJECT_LIST是以空格区分的,譬如: $ repo forall frameworks/base packages/apps/Mms -c "git status"
# B# p9 _+ O& @/ X表示对platform/frameworks/base和platform/packages/apps/Mms同时执行git status命令。 如果没有指定PROJECT_LIST,那么,会对repo管理的所有git库都同时执行命令。 6 R: G% l( F' J& J9 d' f
该命令的还有一些其他参数: ( c) r. O1 I0 f5 a+ A
- -r, –regex: 通过指定一个正则表达式,只有匹配的PROJECT,才会执行指定的命令
- -p:输出结果中,打印PROJECT的名称/ e& l4 `1 @/ g% L
' O- I5 f! w) Q* a3.6 prune: o/ D* N; V7 O P7 B$ }$ M5 r' p# n
- $ repo prune [<PROJECT_LIST>]
复制代码
1 c& Y! A- a% c( U% L2 _. e9 }) L* T4 z
删除指定PROJECT中,已经合并的分支。当在开发分支上代码已经合并到主干分支后,使用该命令就可以删除这个开发分支。 随着时间的演进,开发分支会越来越多,在多人开发同一个git库,多开发分支的情况会愈发明显,假设当前git库有如下分支: - * master
8 O9 s$ S5 S/ R/ D - dev_feature1_201501 # 已经合并到master
) @3 d+ w4 O2 Y# W3 C2 z6 }0 ?& M; w - dev_feature2_201502 # 已经合并到master+ y, y$ [# {$ l/ W
- dev_feature3_201503 # 正在开发中,还有改动记录没有合并到master
复制代码 ) p1 p2 I7 A) m. K
那么,针对该git库使用prune命令,会删除dev_feature1_201501和dev_feature2_201502。 定义删除无用的分支,能够提交团队的开发和管理效率。prune就是删除无用分支的”杀手锏“。
2 p2 @2 J& x- A2 k: M- A9 w3.7start
! W; T1 X/ H. {1 K$ x! D3 ? H- $ repo start <BRANCH_NAME> [<PROJECT_LIST>]
复制代码
4 J, `7 ~2 R, m& V! C% K
% U. a9 w( |9 y在指定的PROJECT的上,切换到<BRANCH_NAME>指定的分支。可以使用–all参数对所有的PROJECT都执行分支切换操作。 该命令实际上是对git checkout命令的封装,<BRANCH_NAME>是自定义的,它将追踪manifest中指定的分支名。
9 {# G1 S8 }2 d: D. c4 h6 U当第一次sync完代码后,可以通过start命令将git库切换到开发分支,避免在匿名分支上工作导致丢失改动内容的情况。
; v+ `3 F* e3 A9 L0 ^+ w" ?3.8 status- ]- i' G H M
- $ repo status [<PROJECT_LIST>]
复制代码 6 A; w% Y) S' P5 X5 ?
' {8 T9 i9 f& e# Cstatus用于查看多个git库的状态。实际上,是对git status命令的封装。 4. 使用实践
+ `9 o; N# w" Y4 [Android推荐的开发流程是: - repo init初始化工程,指定待下载的分支
- repo sync下载代码
- repo start将本地git库切换到开发分支(TOPIC BRANCH)
- 在本地进行修改,验证后,提交到本地
- repo upload上传到服务器,等待review1 [( {$ k7 x9 ?) B
' S& f2 i0 s5 s1 p0 n
在实际使用过程中,我们会用到repo的一些什么子命令和参数呢?哪些参数有助于提高开发效率呢?下面我们以一些实际场景为例展开说明。 # i8 k* R9 I, N# A( a* c' ]8 B* l2 ]
4.1 对项目清单文件进行定制通过local_manifest机制,能够避免了直接修改default.xml,不会造成下次同步远程清单文件的冲突。
# M. }/ _3 H7 yCyanogenMod(CM)适配了上百款机型,不同机型所涉及到的git库很可能是有差异的。以CM对清单文件的定制为例,通过新增local_manifest.xml,内容如下: - <manifest>
$ S: l" v u6 P+ s/ g- b - <!-- add github as a remote source -->
6 r+ A$ n+ A. l7 C5 Y+ j$ O Z - <remote name="github" fetch="git://github.com" />; W3 p1 |2 m$ o ~* u6 r" a
- 9 Y# T, ^7 y" L% D# v
- + I+ Q0 R! M# A
- <!-- remove aosp standard projects and replace with cyanogenmod versions -->
4 V _$ e2 J1 t" K+ Y' C - <remove-project name="platform/bootable/recovery" />( }! G( ]& s! I. C
- <remove-project name="platform/external/yaffs2" />" b) O8 S4 p9 g* V! U: T# u
- <remove-project name="platform/external/zlib" />$ g9 B6 j6 X# T, _ _- f
- <project path="bootable/recovery" name="CyanogenMod/android_bootable_recovery" remote="github" revision="cm-10.1" />
4 Y* N1 M! ~! t, ~) _" h& X - ) G Z1 H$ c2 Q: r
- <project path="external/yaffs2" name="CyanogenMod/android_external_yaffs2" remote="github" revision="cm-10.1" />
) G2 Q% R5 }, T# F% _( z' z+ z - <project path="external/zlib" name="CyanogenMod/android_external_zlib" remote="github" revision="cm-10.1" />
. C) M4 Y0 J8 p- }1 [ - " @' G& |0 g) }7 Z$ P0 c
- <!-- add busybox from the cyanogenmod repository -->
- A# \. h! S3 _! t - <project path="external/busybox" name="CyanogenMod/android_external_busybox" remote="github" revision="cm-10.1" />% P( s) g* c2 r4 y
' }% Y2 C6 N* U1 U- ) Q6 u+ R- j* }5 z3 F
- </manifest>
复制代码 L& o; s C& w; I1 Q
local_manifest.xml会与已有的default.xml融合成一个项目清单文件manifest.xml,实现了对一些git库的替换和新增。 可以通过以下命令导出当前的清单文件,最终snapshot.xml就是融合后的版本: - $ repo manifest -o snapshot.xml -r
复制代码 " K+ m# e) Q+ k3 n |( ?# \
在编译之前,保存整个项目的清单,有助于问题的回溯。当项目的git库发生变更,需要回退到上一个版本进行验证的时候,只需要重新基于snapshot.xml初始化上一个版本即可: - $ cp snapshot.xml .repo/manifests/5 ~) y1 L' p/ c4 N; e6 w2 O
- $ repo init -m snapshot.xml # -m 参数表示自定义manifest4 P# c1 t8 c. \ N, f, X
- $ repo sync -d # -d 参数表示从当前分支脱离,切换到manifest中定义的分支
复制代码
6 t: ~: ?3 @( {: ?! J1 I* L; Q% ^" \5 @/ \ {8 H
4.2 解决无法下载Android源码
6 D. w! H; D9 E7 P& Y在repo init的时候,会从远程下载manifests和repo这两个git库,默认情况下,这两个git库的地址都是写死在repo这个python脚本里面的。对于AOSP而言,这两个git库的地址显然是google提供的。但由于google访问受限的缘故,会导致init时,无法下载manifests和repo。这时候,可以使用init的-u和–repo-url参数,自定义这两个库的地址,辅以–no-repo-verify来绕过代码检查。 - $ repo init --repo-url [PATH/TO/REPO] -u [PATH/TO/MANIFEST] -b
& k) G1 D" C: }" B) w - [BRANCH] --no-repo-verify+ i# Q6 F# [ @# J. Y4 j" ~
- $ repo sync
复制代码 ' g0 y( ~* |- }4 t& }
?9 R$ m8 `4 m8 z! e( j; R1 Q
2 Q3 y* Z; x+ u) L4.3 更快更省的下载远程代码repo默认会同步git库的所有远程分支的代码,但实际开发过程中,用到的分支是有限的。使用sync的-c参数,可以只下载manifest中设定的分支,这会节省代码下载时间以及本地的磁盘空间:
) ?1 k* s1 L6 H, L8 L+ a* T如果实际开发过程中,需要用到另外一个分支,而又不想被其他分支干扰,可以在已有的工程根目录下,使用如下命令: - $ repo manifest -o snapshot.xml -r
7 Z' [! u$ ^- t0 l4 Q* y - $ repo init -u [PATH/TO/MANIFEST] -b [ANOTHER_BRANCH]# S5 a9 d1 s" R) Z9 _
- $ repo sync -c -d
复制代码
" D- G2 E8 R% n, U) S0 D4 k5 p& W0 A8 b. A5 x5 K
以上命令序列,相当更新了manifest,而且仅仅只下载ANOTHER_BRANCH的代码,这样本地只保存了两个分支的代码。利用保存的snapshot.xml,还能将所有git库方便的切换回原来的分支。 ; s2 g% Q7 ]7 C# r
如果本地已经有一份Android源码,假设路径为~/android-exsit,想要下载另一份新的Android源码,通过–reference参数,在数分钟以内,就能将代码下载完毕: - $ mkdir ~/android-new && cd ~/android-new
9 |' A9 H V5 n' S- A" Z - $ repo init --reference=~/android-exsit -u [PATH/TO/MANIFEST] -b [BRANCH]! } ^" v5 M; Z* Q* ]% l
- $ repo sync -c
复制代码
: K1 w5 W4 ^) Y( _4 k 4.4 避免在匿名分支上工作在sync完代码后,所有git库默认都是在一个匿名分支上(no branch),很容易会由于误操作导致丢失代码修改。可以使用如下命令将所有的git库切换到开发分支: - $ repo start BRANCH --all
复制代码
$ T# K" u p, }: D+ r2 Q! a* a% Q7 U; N
4.5 使用upload提交代码开发人员可能同时在多个git库,甚至多个分支上,同时进行修改,针对每个git库单独提交代码是繁琐的。可以使用如下命令,一并提交所有的修改:
' j0 [8 @, @$ r8 \, w. J不用担心会漏提交或者误提交,upload会提供一个交互界面,开发人员选择需要提交的git库和分支即可。 如果需要省去Gerrit上填写reviewer的操作,可以使用–reviewer参数指定Reviewer的邮箱地址: - $ repo upload --reviewer="R.E.viewer@google.com"
复制代码
* j( |$ }2 Q/ h9 V) ?
. Y0 Z: E/ E& o. A4.6 定期删除已经合并的开发分支Git鼓励在修复Bug或者开发新的Feature时,都创建一个新的分支。创建Git分支的代价是很小的,而且速度很快,因此,不用担心创建Git分支的成本,而是尽可能多地使用分支。 $ \6 `# C3 D( p
随着时间的演进,开发分支会越来越多,而一些已经合并到主干的开发分支是没有存在价值的,可以通过prune命令定期删除无用的开发分支: - $ repo prune [PROJECT_LIST]
复制代码
) y3 d% O/ h0 x J" X) \6 R0 I1 f' b
4.7 同时操作多个git库对于部分开发人员而言,同时操作多个git库是常态,如果针对每个git库的操作命令都是相同的,那么可以使用如下命令一次性完成所有操作: - $ repo forall -c "git branch | grep tmp | xargs git branch -D; git branch"
复制代码
. `$ T- `3 J# @& d; _
! w0 p k, f' G: B/ q7 ~4 u# `参数-c指定的命令序列可以很复杂,多条命令只需要用“;”间隔。
$ E* T0 w# X3 ~0 {' u7 b7 p% a" G Q' ^/ }( i) `; i7 h6 t
|