| OLD | NEW |
| 1 # Copyright 2008-2009, Google Inc. | 1 # Copyright 2008-2009, Google Inc. |
| 2 | 2 |
| 3 gclient is a tool for managing a modular checkout of source code | 3 gclient is a tool for managing a modular checkout of source code |
| 4 from multiple source code repositories. It wraps underlying source | 4 from multiple source code repositories. It wraps underlying source |
| 5 code management commands to provide support for distributing tree | 5 code management commands to provide support for distributing tree |
| 6 updates, status commands, and diffs across multiple checked-out | 6 updates, status commands, and diffs across multiple checked-out |
| 7 working directories. | 7 working directories. |
| 8 | 8 |
| 9 | 9 |
| 10 The gclient script is controlled by a ".gclient" file at the top | 10 The gclient script is controlled by a ".gclient" file at the top |
| (...skipping 23 matching lines...) Expand all Loading... |
| 34 The name of the directory in which the solution will be | 34 The name of the directory in which the solution will be |
| 35 checked out. | 35 checked out. |
| 36 | 36 |
| 37 url | 37 url |
| 38 The URL from which this solution will be checked out. | 38 The URL from which this solution will be checked out. |
| 39 gclient expects that the checked-out solution will contain a | 39 gclient expects that the checked-out solution will contain a |
| 40 file named "DEPS" that in turn defines the specific pieces | 40 file named "DEPS" that in turn defines the specific pieces |
| 41 that must be checked out to create the working directory | 41 that must be checked out to create the working directory |
| 42 layout for building and developing the solution's software. | 42 layout for building and developing the solution's software. |
| 43 | 43 |
| 44 deps_file |
| 45 A string containing just the filename (not a path) of the file |
| 46 in the solution dir to use as the list of dependencies. |
| 47 This tag is optional, and defaults to "DEPS". |
| 48 |
| 44 custom_deps | 49 custom_deps |
| 45 A dictionary containing optional custom overrides for entries | 50 A dictionary containing optional custom overrides for entries |
| 46 in the solution's "DEPS" file. This can be used to have | 51 in the solution's "DEPS" file. This can be used to have |
| 47 the local working directory *not* check out and update specific | 52 the local working directory *not* check out and update specific |
| 48 components, or to sync the local working-directory copy of a | 53 components, or to sync the local working-directory copy of a |
| 49 given component to a different specific revision, or a branch, | 54 given component to a different specific revision, or a branch, |
| 50 or the head of a tree. It can also be used to append new entries | 55 or the head of a tree. It can also be used to append new entries |
| 51 that do not exist in the "DEPS" file. | 56 that do not exist in the "DEPS" file. |
| 52 | 57 |
| 53 Within each checked-out solution, gclient expects to find a file | 58 Within each checked-out solution, gclient expects to find a file |
| 54 named "DEPS" which defines the different component pieces of | 59 typically named "DEPS" (it actually uses the value of the 'deps_file' |
| 55 software that must be checked out for the solution. The "DEPS" | 60 key above) which defines the different component pieces of software |
| 56 file is a Python script that defines a dictionary named "deps": | 61 that must be checked out for the solution. The "DEPS" file is a |
| 62 Python script that defines a dictionary named "deps": |
| 57 | 63 |
| 58 deps = { | 64 deps = { |
| 59 "src/outside" : "http://outside-server/trunk@1234", | 65 "src/outside" : "http://outside-server/trunk@1234", |
| 60 "src/component" : "svn://svnserver/component/trunk/src@77829", | 66 "src/component" : "svn://svnserver/component/trunk/src@77829", |
| 61 "src/relative" : "/trunk/src@77829", | 67 "src/relative" : "/trunk/src@77829", |
| 62 } | 68 } |
| 63 | 69 |
| 64 Each item in the "deps" dictionary consists of a key-value pair. | 70 Each item in the "deps" dictionary consists of a key-value pair. |
| 65 The key is the directory into which the component will be checked | 71 The key is the directory into which the component will be checked |
| 66 out, relative to the directory containing the ".gclient" file. | 72 out, relative to the directory containing the ".gclient" file. |
| 67 The value is the URL from which that directory will be checked out. | 73 The value is the URL from which that directory will be checked out. |
| 68 If there is no address scheme (that is, no "http:" or "svn:" prefix), | 74 If there is no address scheme (that is, no "http:" or "svn:" prefix), |
| 69 then the value must begin with a slash and is treated relative to the | 75 then the value must begin with a slash and is treated relative to the |
| 70 root of the solution's repository. | 76 root of the solution's repository. |
| 71 | 77 |
| 72 The URL typically contains a specific revision or change number (as | 78 The URL typically contains a specific revision or change number (as |
| 73 appropriate for the underlying SCM system) to "freeze" the external | 79 appropriate for the underlying SCM system) to "freeze" the external |
| 74 software at a specific, known state. Alternatively, if there is no | 80 software at a specific, known state. Alternatively, if there is no |
| 75 revision or change number, the URL will track the latest changes on the | 81 revision or change number, the URL will track the latest changes on the |
| 76 specific trunk or branch. | 82 specific trunk or branch. |
| OLD | NEW |