depot_tools介绍

Google用python开发的git仓库管理工具，用于管理chromium源码。包括gclient、repo、gn和ninja等工具。是对Git的增强，大项目由几十个独立的git仓库构成，不便于下载、提交和管理。

gclient：将多个git仓库组成一个Solution进行管理，通过gclient获取源码和依赖的仓库，类似Git submodule。

git submodule：git子仓库管理工具

repo：与gclient作用相同，gclient更新一点。gclient根据.gclient和DEPS配置文件检出依赖模块源码，repo根据manifest.xml配置文件检出模块源码。

Solution：包含DEPS文件的仓库

DEPS：记录Solution中的项目依赖关系

roll_deps：用于更新DEPS文件中某个依赖的代码版本

Gerrit/Rietveld：Code Review（代码审核）的系统，可以和git/svn集成

git cl：Change List，用于查看代码修改，类似git diff

LKGR（Last Known Good Revision）：记录最新的测试通过的版本

ninja：编译工具，负责编译最终的可执行文件。依赖其他构建工具进行高级语言编译。

gn：生成ninja所需的构建文件，可以针对不同平台生成不同的ninja构建文件。gn help查看帮助

安装

clone仓库：git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
设置环境变量：.bash_profile文件中添加export PATH=/{your_path}/depot_tools/:$PATH

gn介绍

gn工具将xx.gn文件转换成.ninja文件，ninja根据.ninja文件生成目标程序。类似cmake和make的关系。

官方文档主要有两篇gn命令、gn语法，语法类似python

gn使用

在项目根目录创建.gn文件，用于指定构建配置文件路径，一般叫BUILDCONFIG.gn
在构建配置文件中指定编译工具链
在项目根目录创建BUILD.gn文件，指定编译目标、配置等。
对应的依赖模块中也定义BUILD.gn文件

BUILD.gn文件语法

简单介绍下，具体参考官方文档

添加编译参数

1
2
3

declare_args() {
  enable_test = true
}

添加宏

定义的宏可以直接在C/C++的代码中使用

1	defines = [ "AWESOME_FEATURE", "LOG_LEVEL=3" ]

添加编译单元

target是最小的编译单元，常见的target类型如

executable：生成可执行程序
shared_library：生成动态链接库，如.dll和.so文件
static_library：生成静态链接库，如.lib和.a文件
source_set：生成虚拟静态库，比static_library快
group：执行一组target编译
action：执行一段脚本
copy：拷贝文件

executable("hello_world") {
  sources = [
    "hello_world.cc",
  ]
}

添加配置

包括编译flag、include、define等，可被其他target包含

config("myconfig") {
  include_dirs = [ "include/common" ]
  defines = [ "ENABLE_DOOM_MELON" ]
}

executable("hello_world") {
  configs = [ ":myconfig" ]
}

添加模版

用于定义可重用的代码，一般创建一个.gni文件，其他文件可以通过import引入实现共享

添加依赖关系

1 2	deps = ["//xxx"] deps += ["//xxx"]

gn执行过程

以flutter engine项目为例

在当前目录查找.gn文件，如果不存在则往上一级查找，直到找到一个为止，将.gn所在的目录设置为source root。解析.gn文件找到buildconfig文件（构建配置文件）。如下src/.gn文件：

```
# This file is used by the experimental meta-buildsystem in src/tools/gn to
# find the root of the source tree and to set startup options.

# Use Python 3 for exec_script() calls.
# See `gn help dotfile` for details.
script_executable = "python3"

# The location of the build configuration file.
buildconfig = "//build/config/BUILDCONFIG.gn"

# The secondary source root is a parallel directory tree where
# GN build files are placed when they can not be placed directly
# in the source tree, e.g. for third party source trees.
secondary_source = "//build/secondary/"
```

执行构建配置文件，即//build/config/BUILDCONFIG.gn，整个系统只有一个，设置全局变量、默认值等，对所有build文件可见
执行root目录下的BUILD.gn文件
再根据root目录下的BUILD.gn文件加载其依赖目录下的其他BUILD.gn文件，如果在指定路径找不到的话，则在build/secondary的相应位置查找
当一个目标的依赖都解决了，编译出.ninja文件保存到out_dir/dir下，例如out/android_debug_unopt/obj/下
最终编译出一个根build.ninja文件放到out_dir下

结语

gclient使用可以参考chromium开发工具–gclient、gclient 介绍

Afauria's Blog

depot_tools工具介绍