diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/manifest-format.txt | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/manifest-format.txt b/docs/manifest-format.txt index a54282c8..f6dba640 100644 --- a/docs/manifest-format.txt +++ b/docs/manifest-format.txt | |||
@@ -41,17 +41,20 @@ following DTD: | |||
41 | <!ATTLIST default revision CDATA #IMPLIED> | 41 | <!ATTLIST default revision CDATA #IMPLIED> |
42 | <!ATTLIST default sync-j CDATA #IMPLIED> | 42 | <!ATTLIST default sync-j CDATA #IMPLIED> |
43 | <!ATTLIST default sync-c CDATA #IMPLIED> | 43 | <!ATTLIST default sync-c CDATA #IMPLIED> |
44 | <!ATTLIST default sync-s CDATA #IMPLIED> | ||
44 | 45 | ||
45 | <!ELEMENT manifest-server (EMPTY)> | 46 | <!ELEMENT manifest-server (EMPTY)> |
46 | <!ATTLIST url CDATA #REQUIRED> | 47 | <!ATTLIST url CDATA #REQUIRED> |
47 | 48 | ||
48 | <!ELEMENT project (annotation?)> | 49 | <!ELEMENT project (annotation?, |
50 | project*)> | ||
49 | <!ATTLIST project name CDATA #REQUIRED> | 51 | <!ATTLIST project name CDATA #REQUIRED> |
50 | <!ATTLIST project path CDATA #IMPLIED> | 52 | <!ATTLIST project path CDATA #IMPLIED> |
51 | <!ATTLIST project remote IDREF #IMPLIED> | 53 | <!ATTLIST project remote IDREF #IMPLIED> |
52 | <!ATTLIST project revision CDATA #IMPLIED> | 54 | <!ATTLIST project revision CDATA #IMPLIED> |
53 | <!ATTLIST project groups CDATA #IMPLIED> | 55 | <!ATTLIST project groups CDATA #IMPLIED> |
54 | <!ATTLIST project sync-c CDATA #IMPLIED> | 56 | <!ATTLIST project sync-c CDATA #IMPLIED> |
57 | <!ATTLIST project sync-s CDATA #IMPLIED> | ||
55 | 58 | ||
56 | <!ELEMENT annotation (EMPTY)> | 59 | <!ELEMENT annotation (EMPTY)> |
57 | <!ATTLIST annotation name CDATA #REQUIRED> | 60 | <!ATTLIST annotation name CDATA #REQUIRED> |
@@ -152,7 +155,10 @@ Element project | |||
152 | 155 | ||
153 | One or more project elements may be specified. Each element | 156 | One or more project elements may be specified. Each element |
154 | describes a single Git repository to be cloned into the repo | 157 | describes a single Git repository to be cloned into the repo |
155 | client workspace. | 158 | client workspace. You may specify Git-submodules by creating a |
159 | nested project. Git-submodules will be automatically | ||
160 | recognized and inherit their parent's attributes, but those | ||
161 | may be overridden by an explicitly specified project element. | ||
156 | 162 | ||
157 | Attribute `name`: A unique name for this project. The project's | 163 | Attribute `name`: A unique name for this project. The project's |
158 | name is appended onto its remote's fetch URL to generate the actual | 164 | name is appended onto its remote's fetch URL to generate the actual |
@@ -163,7 +169,8 @@ URL to configure the Git remote with. The URL gets formed as: | |||
163 | where ${remote_fetch} is the remote's fetch attribute and | 169 | where ${remote_fetch} is the remote's fetch attribute and |
164 | ${project_name} is the project's name attribute. The suffix ".git" | 170 | ${project_name} is the project's name attribute. The suffix ".git" |
165 | is always appended as repo assumes the upstream is a forest of | 171 | is always appended as repo assumes the upstream is a forest of |
166 | bare Git repositories. | 172 | bare Git repositories. If the project has a parent element, its |
173 | name will be prefixed by the parent's. | ||
167 | 174 | ||
168 | The project name must match the name Gerrit knows, if Gerrit is | 175 | The project name must match the name Gerrit knows, if Gerrit is |
169 | being used for code reviews. | 176 | being used for code reviews. |
@@ -171,6 +178,8 @@ being used for code reviews. | |||
171 | Attribute `path`: An optional path relative to the top directory | 178 | Attribute `path`: An optional path relative to the top directory |
172 | of the repo client where the Git working directory for this project | 179 | of the repo client where the Git working directory for this project |
173 | should be placed. If not supplied the project name is used. | 180 | should be placed. If not supplied the project name is used. |
181 | If the project has a parent element, its path will be prefixed | ||
182 | by the parent's. | ||
174 | 183 | ||
175 | Attribute `remote`: Name of a previously defined remote element. | 184 | Attribute `remote`: Name of a previously defined remote element. |
176 | If not supplied the remote given by the default element is used. | 185 | If not supplied the remote given by the default element is used. |
@@ -190,6 +199,8 @@ its name:`name` and path:`path`. E.g. for | |||
190 | definition is implicitly in the following manifest groups: | 199 | definition is implicitly in the following manifest groups: |
191 | default, name:monkeys, and path:barrel-of. If you place a project in the | 200 | default, name:monkeys, and path:barrel-of. If you place a project in the |
192 | group "notdefault", it will not be automatically downloaded by repo. | 201 | group "notdefault", it will not be automatically downloaded by repo. |
202 | If the project has a parent element, the `name` and `path` here | ||
203 | are the prefixed ones. | ||
193 | 204 | ||
194 | Element annotation | 205 | Element annotation |
195 | ------------------ | 206 | ------------------ |