google的chromium项目是用gclient来管理源码的checkout, update等。 gclient是google专门为这种多源项目编写的脚本,它可以将多个源码管理系统中的代码放在一起管理。甚至包括将Git和svn代码放在一起。
webrtc也是使用gclient管理代码.
gclient的sync,update等命令密切相关的两类文件.gclient和DEPS。
.gclient文件是gclient的控制文件,该文件放在工作目录的最上层(webrtc环境下与src统计目录)。”.gclient”文件是一个Python的脚本,定义了一组”solutions”,格式类似如下
1 | solutions = [ |
name:checkout出源码的名字
url:源码所在的目录,gclient希望checkout出的源码中包括一个DEPS的文件,这个文件包含了必须checkout到工作目录的源码信息;
deps_file:这是一个文件名(不包括路径),指在工程目录中包含依赖列表的文件,该项可选,默认值为”DEPS”
custom_deps:这是一个可选的字典对象,会覆盖工程的”DEPS”文件定义的条目.一般它用作本地目录中,那些不用checkout的代码,或者让本地目录从不同位置checkout一个新的代码出来,或者checkout不同的分支,版本等.也可以用于增加在DEPS中不存在的新的项目.如:
1
2
3
4
5
6
7
8"custom_deps": {
"src/content/test/data/layout_tests/LayoutTests": None,
"src/chrome/tools/test/reference_build/chrome_win": None,
"src/chrome_frame/tools/test/reference_build/chrome_win": None,
"src/chrome/tools/test/reference_build/chrome_linux": None,
"src/chrome/tools/test/reference_build/chrome_mac": None,
"src/third_party/hunspell_dictionaries": None,
},target_os:这个可选的条目可以指出特殊的平台,根据平台类checkout出不同代码,如:
1
target_os = ['android']
如果target_os_only值为True的话,那么,仅仅checkout出对应的代码,如:
1 | target_os = [ "ios" ] |
在每个checkout出的工程中,gclient期望发现一个DEPS文件(由deps_file来给定),它定义了工程不同部分都是如何checkout出来。 “DEPS”也是一个python脚本,最简单的,如下:
1 | deps = { |
deps的每个条目都包含一个key-value对,key是被checkout的本地目录,而value就是对应的远程URL。如果路径是以’/‘开头的,那么它是一个相对URL,相对与.gclient中URL地址。
URL通常包含一个版本号,以便锁定源码在特定版本上。当然,这是可选的。如果没有,那么它将获取指定分支上最新的版本。
DEPS还可以包含其他类型的数据,如vars,
1 | vars = { |
vars定义了一组变量,在后面,可以通过Var(xxx)来访问。Var(xxx)返回一个字符串,故此,也可以进行操作,如
1 | 'src/third_party/cros_dbus_cplusplus/source': |
第二个自立,Var(“webkit_trunk”)[:-6]是一个python表达式,表示取得”webkit_trunk”表示的字符串的最后6个 Hooks:DEPS包含可选的内容 hooks,也有重要的作用,它表示在sync, update或者recert后,执行一个hook操作。 如果使用 –nohooks选项(hook默认执行),那么在gclient sync或者其他操作后,不会执行hook。你可以通过gclient runhooks来单独执行; 如果有 gclient sync –force,那么,无论sync是否成功,都会执行hook。 hook在DEPS中的写法,一般是:
1 | hooks = [ |
hooks包含一组hook,每个hook有几个重要项:
- pattern 是一个正则表达式,用来匹配工程目录下的文件,一旦匹配成功,action项就会执行
- action 描述一个根据特定参数运行的命令行。这个命令在每次gclient时,无论多少文件匹配,至多运行一次。这个命令和.gclient在同一目录下运行。如果第一个参数是”python”,那么,当前的python解释器将被使用。如果包含字符串 “$matching_files”,它将该字符串扩展为匹配出的文件列表。
- name 可选,标记出hook所属的组,可以被用来覆盖和重新组织。
deps_os: DEPS中定义不同平台依赖关系的项目,如
1 |
|
deps_os指定不同平台的依赖,它可以包含多种平台,和.gclient中的target_os对应。这种对应关系如下:
1 |
|
下载webrtc android代码的.gclient文件(与src同级目录):
1 | solutions = [ |
src同级目录下.gclient_entries定义了各模块及对应地址
1 | entries = { |