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