OLD | NEW |
1 # gclient | 1 # gclient |
2 | 2 |
3 gclient is a tool for managing a modular checkout of source code from multiple | 3 gclient is a tool for managing a modular checkout of source code from multiple |
4 source code repositories. It wraps underlying source code management commands | 4 source code repositories. It wraps underlying source code management commands |
5 to provide support for distributing tree updates, status commands, and diffs | 5 to provide support for distributing tree updates, status commands, and diffs |
6 across multiple checked-out working directories. | 6 across multiple checked-out working directories. |
7 | 7 |
8 The gclient script is controlled by a `.gclient` file at the top of a directory | 8 The gclient script is controlled by a `.gclient` file at the top of a directory |
9 tree which will contain source code from multiple locations. A `.gclient` file | 9 tree which will contain source code from multiple locations. A `.gclient` file |
10 is a Python script that defines a list of `solutions` with the following format: | 10 is a Python script that defines a list of `solutions` with the following format: |
11 | 11 |
12 solutions = [ | 12 solutions = [ |
13 { "name" : "src", | 13 { "name" : "src", |
14 "url" : "svn://svnserver/component/trunk/src", | 14 "url" : "https://chromium.googlesource.com/chromium/src.git", |
15 "custom_deps" : { | 15 "custom_deps" : { |
16 # To use the trunk of a component instead of what's in DEPS: | 16 # To use the trunk of a component instead of what's in DEPS: |
17 #"component": "https://svnserver/component/trunk/", | 17 #"component": "https://github.com/luci/luci-go", |
18 # To exclude a component from your working copy: | 18 # To exclude a component from your working copy: |
19 #"data/really_large_component": None, | 19 #"data/really_large_component": None, |
20 } | 20 } |
21 }, | 21 }, |
22 ] | 22 ] |
23 | 23 |
24 A `solution` is a collection of component pieces of software that will be | 24 A `solution` is a collection of component pieces of software that will be |
25 checked out in a specific directory layout for building together. | 25 checked out in a specific directory layout for building together. |
26 | 26 |
27 Each entry in the `solutions` list is defined by a Python dictionary that | 27 Each entry in the `solutions` list is defined by a Python dictionary that |
(...skipping 23 matching lines...) Expand all Loading... |
51 deps = { | 51 deps = { |
52 "src/outside": "https://outside-server/one/repo.git@1234567789012345677890
1234567789012345677890", | 52 "src/outside": "https://outside-server/one/repo.git@1234567789012345677890
1234567789012345677890", |
53 "src/component": "https://dont-use-github.com/its/unreliable.git@000000000
0000000000000000000000000000000", | 53 "src/component": "https://dont-use-github.com/its/unreliable.git@000000000
0000000000000000000000000000000", |
54 "src/relative": "/another/repo.git@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
a", | 54 "src/relative": "/another/repo.git@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
a", |
55 } | 55 } |
56 | 56 |
57 Each item in the `deps` dictionary consists of a key-value pair. The key is the | 57 Each item in the `deps` dictionary consists of a key-value pair. The key is the |
58 directory into which the component will be checked out, relative to the | 58 directory into which the component will be checked out, relative to the |
59 directory containing the `.gclient` file. The value is the URL from which that | 59 directory containing the `.gclient` file. The value is the URL from which that |
60 directory will be checked out. If there is no address scheme (that is, no | 60 directory will be checked out. If there is no address scheme (that is, no |
61 `http:` or `svn:` prefix), then the value must begin with a slash and is treated | 61 `http:` prefix), then the value must begin with a slash and is treated |
62 relative to the root of the solution's repository. | 62 relative to the root of the solution's repository. |
63 | 63 |
64 The URL typically contains a specific revision or change number (as appropriate | 64 The URL typically contains a specific revision or change number (as appropriate |
65 for the underlying SCM system) to `freeze` the external software at a specific, | 65 for the underlying SCM system) to `freeze` the external software at a specific, |
66 known state. Alternatively, if there is no revision or change number, the URL | 66 known state. Alternatively, if there is no revision or change number, the URL |
67 will track the latest changes on the specific trunk or branch. | 67 will track the latest changes on the specific trunk or branch. |
OLD | NEW |