EDA365欢迎您登录!
您需要 登录 才可以下载或查看,没有帐号?注册
x
本帖最后由 Heaven_1 于 2024-10-28 16:28 编辑
+ \4 [' @0 N/ T N
( K- H2 I4 U/ `1. 概要 & w. N% e+ P C" n
repo是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 >
! g: q/ T. V3 g - ~/bin/repo
: ^1 Y* ?; V) h3 m3 e - $ chmod a+x~/bin/repo
复制代码
( m9 d, t G' d: [9 y, j6 Z由于国内Google访问受限,所以上述命令不一定能下载成功。其实,我们现在可以从很多第三方渠道找到repo脚本,只需要取下来,确保repo可以正确执行即可。 ; M. R2 M3 W. Q
2. 工作原理 c4 B8 x" A& }3 Q/ v2 t
repo需要关注当前git库的数量、名称、路径等,有了这些基本信息,才能对这些git库进行操作。通过集中维护所有git库的清单,repo可以方便的从清单中获取git库的信息。 这份清单会随着版本演进升级而产生变化,同时也有一些本地的修改定制需求,所以,repo是通过一个git库来管理项目的清单文件的,这个git库名字叫manifests。
- V+ o5 w. E9 U1 {; |当打开repo这个可执行的python脚本后,发现代码量并不大(不超过1000行),难道仅这一个脚本就完成了AOSP数百个git库的管理吗?并非如此。 repo是一系列脚本的集合,这些脚本也是通过git库来维护的,这个git库名字叫repo。 2 A3 z6 b1 ?0 z' j# j- X$ t
在客户端使用repo初始化一个项目时,就会从远程把manifests和repo这两个git库拷贝到本地,但这对于Android开发人员来说,又是近乎无形的(一般通过文件管理器,是无法看到这两个git库的)。 repo将自动化的管理信息都隐藏根目录的.repo子目录中。
* t: Y; }- a# o v, ~ V2 {2.1 项目清单库(.repo/manifests) AOSP项目清单git库下,只有一个文件default.xml,是一个标准的XML,描述了当前repo管理的所有信息。 AOSP的default.xml的文件内容如下: - <?xmlversion="1.0" encoding="UTF-8"?>
, j* X* N9 `8 u( S - <manifest>
7 d \$ E& e ]. |" _ - <remote name="aosp"
* U* T g& Q$ v+ d1 b! k0 n7 T - fetch=".."$ v5 {! O. C' e1 R9 S4 p% H3 c( A
- review="https://android-review.googlesource.com/" />
* x, z' d& i1 Q o8 X - <default revision="master"
. m) ?! Z& D0 w7 Z. p) D - remote="aosp"
' V; {" n- s! u2 O' f- T - sync-j="4" />$ _. U6 @7 C. B1 r9 j1 p/ ]
- <project path="build"name="platform/build" groups="pdk,tradefed" >
8 _; C0 c) n# c2 q0 ~ - <copyfilesrc="core/root.mk" dest="Makefile" />, O( ^' r+ r. B
- </project>4 v* L& k) V& u: G/ p
- <project path="abi/cpp"name="platform/abi/cpp" groups="pdk" />
2 E. y$ n p4 g$ f$ v [ - <project path="art"name="platform/art" groups="pdk" />
1 [ c1 ? e& ~. ~) f - .../ z. }' p; p, L4 G4 H
- <projectpath="tools/studio/translation"name="platform/tools/studio/translation"groups="notdefault,tools" /> C0 C$ g: n$ G' A+ g) Q7 [
- <project path="tools/swt"name="platform/tools/swt" groups="notdefault,tools" />0 P# P* A) F8 D
- </manifest>
复制代码 $ P; b0 o* z) P2 y
" x) j# Q \8 o% f
- :描述了远程仓库的基本信息。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/ [- R/ A$ ~6 f1 Q' \' [
5 ~% S* m1 }3 S0 e" y) U+ n. i
如果需要新增或替换一些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
5 I; T* `2 L2 |# Y4 X - local_manifest.xml
9 `8 | a* T! M) ]+ `* u. j - another_local_manifest.xml+ k1 H3 F, R9 A9 z( E; X6 E
; x L. t5 W! Z+ {6 o( U9 ~; b7 `6 k- $ cat.repo/local_manifests/local_manifest.xml
7 B: {) e! H1 H2 s" A - <?xmlversion="1.0" encoding="UTF-8"?>% a, K1 E _0 `( @* P+ W9 z
- <manifest>0 x- f: b# i& `) r
- <project path="manifest"name="tools/manifest" />+ `( |$ T& `2 l' E/ ^
- <projectpath="platform-manifest" name="platform/manifest" />0 U* G) \5 x" G
- </manifest>
复制代码
* Z+ `/ U6 ~1 B a1 [( n$ E4 V- I8 Y" _* v& t2 \- e9 t
2.2 repo脚本库(.repo/repo) repo对git命令进行了封装,提供了一套repo的命令集(包括init,sync等),所有repo管理的自动化实现也都包含在这个git库中。 在第一次初始化的时候,repo会从远程把这个git库下载到本地。 + ^- Q( [+ ]0 u9 C
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命令。
0 c$ {! \& X; ?/ |( V6 t3 m ~- y
既然.repo目录下保存了项目的所有信息,所有要拷贝一个项目时,只是需要拷贝这个目录就可以了。repo支持从本地已有的.repo中恢复原有的项目。 g/ e0 o5 B5 \5 z! F+ p$ l
2.4 repo 目录结构分析 - .repo:% u, u, w( }0 e: j4 R
此为repo目录,可用于提取相应项目工作目录到外面的repo工作目录。 - .repo/manifests.git:1 F4 t/ d) E/ K' g' ]+ C. E
此为repo配置信息的git库,不同版本包含不同配置信息。每个repo项目初始化后也会有自己的git仓库的repo也会建立一个Git仓库,用来记录当前Android版本下各个子项目的Git仓库分别处于哪一个分支,这个仓库通常叫做:manifest仓库。 - .repo/manifests:. X5 t- h0 T X
此为repo配置信息的工作目录(将配置信息的工作目录和相应的实际git目录分离管理,并且配置信息中的.git目录实际只是指向实际git库的软连接)。此目录中可能包含一个或多个xml文件描述的配置。每个xml文件是独立的一套配置,配置内容包括当前repo工作目录包含哪些git项目、所有git项目所处的默认公共分支、以及远端地址等。 - .repo/manifest.xml:; Z* M0 a8 x2 Y% |1 H
repo工作目录中的内容同一时刻只能采用manifests中的一个xml文件做为其配置,该文件就是其软连接,通过init的-m选项指定采用哪个文件;另外,同一xml文件也可能处于manifests库的不同版本或者不同分支,通过init的-b选项指定使用manifests中的哪个分支,每次init命令都会从服务器更新最新的配置。这里通过-m指定的manifests中的xml文件中。 - .repo/repo:
* L2 _& q0 s" t4 b! | y
此为repo脚本集的git库,用于repo管理所需的各种脚本,repo的所有子命令就是其中的对应脚本实现。这些脚本也通过git管理,.repo/repo/.git为对其应的git目录,用git进行版本管理。
$ A# @2 w8 s7 `) n: a* ]3. 使用介绍
7 e3 s& X( Z5 _) O! d: v9 w1 Srepo命令的使用格式如下所示: - $ repo <COMMAND> <OPTIONS>
复制代码
& ~% o9 T- i+ x% Z) q: c. M( f; L" D, v. |) I8 `! u: b
可选的的有:help、init、sync、upload、diff、download、forall、prune、start、status,每一个命令都有实际的使用场景, 下面我们先对这些命令做一个简要的介绍:
& g9 b% h9 ?9 o* h7 M3.1 init
& a) u* ]6 v# s- O% T' t9 Z- $ repo init -u <URL> [<OPTIONS>]
复制代码 ' W4 k( d8 D* }; Q- @( \" V
1 U/ J9 v: G) f$ R6 l$ e
- -u:指定manifests这个远程git库的URL,manifests库是整个项目的清单。默认情况,这个git库只包含了default.xml一个文件,其内容可以参见Android的样本
- -m, –manifest-name:指定所需要的manifests库中的清单文件。默认情况下,会使用maniftests/default.xml
- -b, –manifest-branch:指定manifest.xml文件中的一个版本,,也就是俗称的“分支”运行该命令后,会在当前目录下新建一个.repo子目录:
& ^3 J1 F5 X: W# x' f * X, A6 T1 [& h; N1 B" |
.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
0 z9 @# E' ?1 r( O V - --------------------
* J. `- m4 n! W - mkdir .repo; cd .repo
: s5 u: Q/ u$ B4 e# h# A - git clone --bare $URL manifests.git! k5 H' _3 K% f& w- c, h
- git clone https://android.googlesource.com/tools/repo
" @' L9 C: v7 i. W Z - mkdir -p manifests/.git; cd manifests/.git5 U1 p P, a: \* Z" X$ q) [' A
- for i in ../../manifests.git/*; do ln -s $ı .; done, N4 f& \4 ?3 w0 E0 N8 g H
- cd ..
0 R1 V1 C; p0 V" Z% S( x6 u - git checkout $BRANCH -- .- t! e7 c+ ?$ ]% Y. V) R5 N
- cd ..
/ ?' C8 \/ d3 W4 P5 x1 a; z - ln -s manifests/$MANIFEST manifest.xml
复制代码
4 @) K+ k# ] _ b! D
$ h3 E3 h: C( Q* l首先,在当前目录下创建.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命令了。
8 y3 F) @: U9 q. j( L9 a! k我们还介绍几个不常用的参数,在国内下载Android源码时,会用到: - ^6 h( t- C) K s* l4 q
- –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库时,可能会导致检查不通过,所以可以配套使用该参数,强制不进行检查
5 _1 X5 m* C8 f1 D0 |) ?7 [ d 0 P, G% Q& P/ o; W; n5 z
3.2 sync
! N. @6 b* U e+ z! t% A- $ repo sync [PROJECT_LIST]
复制代码
% H% R% _/ M2 L" {' x# S
. P; J! ` w6 ^下载远程代码,并将本地代码更新到最新,这个过程称为“同步”。如果不使用任何参数,那么会对所有repo管理的进行同步操作;也可以PROJECT_LIST参数,指定若干要同步的PROJECT。 根据本地git库代码不同,同步操作会有不同的行为:
2 K! `. p3 f( l9 M L* P- 当本地的git库是第一次触发同步操作时,那么,该命令等价于git clone,会将远程git库直接拷贝到本地
- 当本地已经触发过同步操作时,那么,该命令等价于git remote update && git rebase origin/,就是当前与本地分支所关联的远程分支 代码合并可能会产生冲突,当冲突出现时,只需要解决完冲突,然后执行git rebase --continue即可。3 w7 x* O) u4 e5 ]8 b& X7 d
当sync命令正确执行完毕后,本地代码就同远程代码保持一致了。在一些场景下,我们会用到sync命令的一些参数:
( Y. |/ Z6 J) ^4 I4 O: e- -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库, ~& \$ g# x7 W+ A; g
6 u* W1 n6 z k3 ?- R; i
3.3 upload W: V) {/ {$ \
- $ repo upload [PROJECT_LIST]
复制代码 ( \! ^: }+ B) z- Y% @
! ~# k" ~9 `. u
从字面意思理解,upload就是要上传,将本地的代码上传到远程服务器。upload命令首先会找出本地分支从上一次同步操作以来发生的改动,然后会将这些改动生成Patch文件,上传至Gerrit服务器。 如果没有指定PROJECT_LIST,那么upload会找出所有git库的改动;如果某个git库有多个分支,upload会提供一个交互界面,提示选择其中若干个分支进行上传操作。
, y. I( r$ ^2 M& U* Xupload并不会直接将改动合并后远程的git库,而是需要先得到Reviewer批准。Reviewer查看改动内容、决定是否批准合入代码的操作,都是通过Gerrit完成。 Gerrit服务器的地址是在manifests中指定的:打开.repo/manifest.xml,这个XML TAG中的review属性值就是Review服务器的URL: - <remote name="aosp"
, `) a1 B: z2 _2 M - fetch=".."- \1 P7 U0 J6 |% e2 _3 u; v1 c
- review="https://android-review.googlesource.com/" />
复制代码
* I6 u9 v& r- x+ ~! V% T I, eGerrit的实现机制不是本文讨论的内容,但有几个与Gerrit相关的概念,是需要代码提交人员了解的:
0 c5 f9 n0 G3 \8 l! m% ~( }" c- 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中,只有最新的一个是真正有用的,能够合并的。
7 W; w8 ?4 H) ` + S g1 e3 }* y6 ]9 X3 Y6 z' o
3.4 download0 y- c: W* p, ^
- $ repo download <TARGET> <CHANGE>
复制代码
) \, U5 f9 s2 v' |! o& Y/ C9 k: Z( d4 C: \: E( r4 W* |* i: M& B- y" g1 u7 [
upload是把改动内容提交到Gerrit,download是从Gerrit下载改动。与upload一样,download命令也是配合Gerrit使用的。 # _- X: `# d; C/ F! N# L& @
- :指定要下载的PROJECT,譬如platform/frameworks/base, platform/packages/apps/Mms
- :指定要下载的改动内容。这个值不是Commit-ID,也不是Change-ID,而是一个Review任务URL的最后几位数字。 譬如,AOSP的一个Review任务https: //android-review.googlesource.com/#/c/23823/,其中23823就是。
: X; z$ C+ c" u; o" S, |
- b @! K; z1 P8 N, t/ j! K+ {3.5 forall6 n! b. ^& w" B$ S6 R- a* b3 T
- $ repo forall [PROJECT_LIST] -c <COMMAND>
复制代码 1 m/ C1 t2 V$ F
) r/ P' ]8 N! n/ Y
对指定的git库执行-c参数制定的命令序列。在管理多个git库时,这是一条非常实用的命令。PROJECT_LIST是以空格区分的,譬如: $ repo forall frameworks/base packages/apps/Mms -c "git status"
7 l q4 e7 {5 [7 r. p表示对platform/frameworks/base和platform/packages/apps/Mms同时执行git status命令。 如果没有指定PROJECT_LIST,那么,会对repo管理的所有git库都同时执行命令。 9 ]: i+ \0 `# m# m; c/ m2 t1 T* X. r
该命令的还有一些其他参数:
$ e# v4 i& Y x( k, L6 _- -r, –regex: 通过指定一个正则表达式,只有匹配的PROJECT,才会执行指定的命令
- -p:输出结果中,打印PROJECT的名称
8 z# P+ h! P* O4 f & \/ l. ?5 U1 f; ^6 A% {/ ~
3.6 prune2 W8 {$ F+ x7 T3 Q0 a
- $ repo prune [<PROJECT_LIST>]
复制代码
! w! F3 `( c% r
# r6 R- O( O( U0 O: \( i" e+ o/ {8 C# s删除指定PROJECT中,已经合并的分支。当在开发分支上代码已经合并到主干分支后,使用该命令就可以删除这个开发分支。 随着时间的演进,开发分支会越来越多,在多人开发同一个git库,多开发分支的情况会愈发明显,假设当前git库有如下分支: - * master' r, `& d' L2 ?3 Y% H' @
- dev_feature1_201501 # 已经合并到master
+ e, t1 K$ P7 B5 K4 a4 D - dev_feature2_201502 # 已经合并到master" v( K9 x8 _1 g- |5 a% W: i
- dev_feature3_201503 # 正在开发中,还有改动记录没有合并到master
复制代码 # |% e+ X1 D, p: U, }$ @7 l8 g2 d
那么,针对该git库使用prune命令,会删除dev_feature1_201501和dev_feature2_201502。 定义删除无用的分支,能够提交团队的开发和管理效率。prune就是删除无用分支的”杀手锏“。
' ^' w( ? L" R g1 _3.7start {3 Y% D$ K" K9 R' s# ]$ p
- $ repo start <BRANCH_NAME> [<PROJECT_LIST>]
复制代码 + P) \ E2 Z0 d" v
# A4 ]; C* r6 w" w1 `
在指定的PROJECT的上,切换到<BRANCH_NAME>指定的分支。可以使用–all参数对所有的PROJECT都执行分支切换操作。 该命令实际上是对git checkout命令的封装,<BRANCH_NAME>是自定义的,它将追踪manifest中指定的分支名。 ) \2 R0 R6 d5 m/ U: ]! e
当第一次sync完代码后,可以通过start命令将git库切换到开发分支,避免在匿名分支上工作导致丢失改动内容的情况。 3 S* y" N$ d) N7 ~$ b5 D+ j. s
3.8 status
/ l& S2 E! E" h& Y Q E% e- $ repo status [<PROJECT_LIST>]
复制代码
, C; K4 c \* J! _
$ h. H" v# y$ b+ T/ s5 M2 ~, ?% }. w1 dstatus用于查看多个git库的状态。实际上,是对git status命令的封装。 4. 使用实践
: R1 T9 j. [5 _Android推荐的开发流程是: - repo init初始化工程,指定待下载的分支
- repo sync下载代码
- repo start将本地git库切换到开发分支(TOPIC BRANCH)
- 在本地进行修改,验证后,提交到本地
- repo upload上传到服务器,等待review
1 y0 M7 S( D: S% P% ~/ i! q
% A/ J B8 p3 o% G在实际使用过程中,我们会用到repo的一些什么子命令和参数呢?哪些参数有助于提高开发效率呢?下面我们以一些实际场景为例展开说明。 / f$ M( ?3 H6 M0 p
4.1 对项目清单文件进行定制通过local_manifest机制,能够避免了直接修改default.xml,不会造成下次同步远程清单文件的冲突。
! C8 k, w# c0 i3 ]CyanogenMod(CM)适配了上百款机型,不同机型所涉及到的git库很可能是有差异的。以CM对清单文件的定制为例,通过新增local_manifest.xml,内容如下: - <manifest>
$ V+ {6 q" i; n6 ^" M( f; M - <!-- add github as a remote source -->
) r( _% H6 O' ^2 l$ m7 y) y+ z - <remote name="github" fetch="git://github.com" />
3 }# ?; F$ Z* ?5 w0 A0 S
% |! k) I) p) M-
2 |) ~% _) K+ x9 A3 Z - <!-- remove aosp standard projects and replace with cyanogenmod versions -->! T, [2 B% r* K7 V, q2 V
- <remove-project name="platform/bootable/recovery" />% \$ N9 t- |" G. D0 l0 ?
- <remove-project name="platform/external/yaffs2" />
1 |! \- v8 n* q - <remove-project name="platform/external/zlib" />
& r$ N7 H, ?% L8 T - <project path="bootable/recovery" name="CyanogenMod/android_bootable_recovery" remote="github" revision="cm-10.1" />$ y* T, q0 Y5 F. F1 u: V
! r/ R7 z! j5 L- <project path="external/yaffs2" name="CyanogenMod/android_external_yaffs2" remote="github" revision="cm-10.1" />/ a p0 ~8 z: x
- <project path="external/zlib" name="CyanogenMod/android_external_zlib" remote="github" revision="cm-10.1" />
) m/ | m- U1 Y7 M% \5 o4 A - + K2 f$ z6 M N( v/ G
- <!-- add busybox from the cyanogenmod repository -->- x( z" T r$ L/ W+ ~2 }" `
- <project path="external/busybox" name="CyanogenMod/android_external_busybox" remote="github" revision="cm-10.1" />
% E# \" q" Y E/ c8 q. L/ y
4 s: n8 @& S1 R) m! |% A5 e-
8 K) [2 [* {4 M - </manifest>
复制代码
2 Q: `; V1 N4 o+ Z! |7 M2 jlocal_manifest.xml会与已有的default.xml融合成一个项目清单文件manifest.xml,实现了对一些git库的替换和新增。 可以通过以下命令导出当前的清单文件,最终snapshot.xml就是融合后的版本: - $ repo manifest -o snapshot.xml -r
复制代码
L* w% k& v+ `: k# e在编译之前,保存整个项目的清单,有助于问题的回溯。当项目的git库发生变更,需要回退到上一个版本进行验证的时候,只需要重新基于snapshot.xml初始化上一个版本即可: - $ cp snapshot.xml .repo/manifests/4 ]) R r& g5 [& F3 Y0 h
- $ repo init -m snapshot.xml # -m 参数表示自定义manifest
5 u1 |/ o% ?" l - $ repo sync -d # -d 参数表示从当前分支脱离,切换到manifest中定义的分支
复制代码 * q: `% x! W+ N0 z9 ^$ N; Z% Z- @
3 Z, Q [& c" r9 ?9 x! t0 g4.2 解决无法下载Android源码
/ H6 D8 m% x' t7 v: h9 j) r9 v" H在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
: M# e- J! `# W; g; F- o - [BRANCH] --no-repo-verify& R0 ?- @& W. ~
- $ repo sync
复制代码 0 V) Y8 V. Q; ]# Y
$ W& o& z4 e$ y E4 `! p) Z1 L4 x, m# h J4 m8 Z( W
4.3 更快更省的下载远程代码repo默认会同步git库的所有远程分支的代码,但实际开发过程中,用到的分支是有限的。使用sync的-c参数,可以只下载manifest中设定的分支,这会节省代码下载时间以及本地的磁盘空间: , v' w0 A: O$ f! b0 D, o% x
如果实际开发过程中,需要用到另外一个分支,而又不想被其他分支干扰,可以在已有的工程根目录下,使用如下命令: - $ repo manifest -o snapshot.xml -r6 u7 ?6 F L) I m" D) H
- $ repo init -u [PATH/TO/MANIFEST] -b [ANOTHER_BRANCH]
I: _0 U2 L" E/ W2 \ - $ repo sync -c -d
复制代码
; n7 y |& [9 v1 ~- x% K1 K( B. g6 E1 ?( a0 ~$ R2 d0 C
以上命令序列,相当更新了manifest,而且仅仅只下载ANOTHER_BRANCH的代码,这样本地只保存了两个分支的代码。利用保存的snapshot.xml,还能将所有git库方便的切换回原来的分支。
1 q: ~+ C, a( W/ y* u2 p' s6 P% g如果本地已经有一份Android源码,假设路径为~/android-exsit,想要下载另一份新的Android源码,通过–reference参数,在数分钟以内,就能将代码下载完毕: - $ mkdir ~/android-new && cd ~/android-new
0 q: R3 y0 L7 u8 c# h - $ repo init --reference=~/android-exsit -u [PATH/TO/MANIFEST] -b [BRANCH]
* v) Y6 |6 `, @8 N5 Q' u& A4 R - $ repo sync -c
复制代码
- L$ p$ X/ ?7 z: n2 g) Q& X. i: l 4.4 避免在匿名分支上工作在sync完代码后,所有git库默认都是在一个匿名分支上(no branch),很容易会由于误操作导致丢失代码修改。可以使用如下命令将所有的git库切换到开发分支: - $ repo start BRANCH --all
复制代码 3 B, ~0 X9 z$ |) L m; Y2 M
0 B# y3 E0 c' N. \, I" ~4.5 使用upload提交代码开发人员可能同时在多个git库,甚至多个分支上,同时进行修改,针对每个git库单独提交代码是繁琐的。可以使用如下命令,一并提交所有的修改: ' F5 i, g; g- W" E6 b
不用担心会漏提交或者误提交,upload会提供一个交互界面,开发人员选择需要提交的git库和分支即可。 如果需要省去Gerrit上填写reviewer的操作,可以使用–reviewer参数指定Reviewer的邮箱地址: - $ repo upload --reviewer="R.E.viewer@google.com"
复制代码 * Y: s2 C5 y; Y. L9 [8 p
" }+ D# e3 M+ q
4.6 定期删除已经合并的开发分支Git鼓励在修复Bug或者开发新的Feature时,都创建一个新的分支。创建Git分支的代价是很小的,而且速度很快,因此,不用担心创建Git分支的成本,而是尽可能多地使用分支。 ; G) {& n. x/ y& L0 O) v
随着时间的演进,开发分支会越来越多,而一些已经合并到主干的开发分支是没有存在价值的,可以通过prune命令定期删除无用的开发分支: - $ repo prune [PROJECT_LIST]
复制代码 1 L5 c# `+ N8 {* d7 }7 d3 l9 y) p
5 Y- [) v( _# m! D0 V" v, c( q2 a$ r4.7 同时操作多个git库对于部分开发人员而言,同时操作多个git库是常态,如果针对每个git库的操作命令都是相同的,那么可以使用如下命令一次性完成所有操作: - $ repo forall -c "git branch | grep tmp | xargs git branch -D; git branch"
复制代码 9 L: t; P% q# }1 @& g3 ^( {6 M J
5 M# K9 b4 }/ a; s/ o7 r. m |; [参数-c指定的命令序列可以很复杂,多条命令只需要用“;”间隔。
% ?# m) @/ w3 x0 X4 i ]
- V1 ^4 K; u1 P |