summaryrefslogtreecommitdiffstats
path: root/docs/manifest-format.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manifest-format.txt')
-rw-r--r--docs/manifest-format.txt17
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
153One or more project elements may be specified. Each element 156One or more project elements may be specified. Each element
154describes a single Git repository to be cloned into the repo 157describes a single Git repository to be cloned into the repo
155client workspace. 158client workspace. You may specify Git-submodules by creating a
159nested project. Git-submodules will be automatically
160recognized and inherit their parent's attributes, but those
161may be overridden by an explicitly specified project element.
156 162
157Attribute `name`: A unique name for this project. The project's 163Attribute `name`: A unique name for this project. The project's
158name is appended onto its remote's fetch URL to generate the actual 164name 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:
163where ${remote_fetch} is the remote's fetch attribute and 169where ${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"
165is always appended as repo assumes the upstream is a forest of 171is always appended as repo assumes the upstream is a forest of
166bare Git repositories. 172bare Git repositories. If the project has a parent element, its
173name will be prefixed by the parent's.
167 174
168The project name must match the name Gerrit knows, if Gerrit is 175The project name must match the name Gerrit knows, if Gerrit is
169being used for code reviews. 176being used for code reviews.
@@ -171,6 +178,8 @@ being used for code reviews.
171Attribute `path`: An optional path relative to the top directory 178Attribute `path`: An optional path relative to the top directory
172of the repo client where the Git working directory for this project 179of the repo client where the Git working directory for this project
173should be placed. If not supplied the project name is used. 180should be placed. If not supplied the project name is used.
181If the project has a parent element, its path will be prefixed
182by the parent's.
174 183
175Attribute `remote`: Name of a previously defined remote element. 184Attribute `remote`: Name of a previously defined remote element.
176If not supplied the remote given by the default element is used. 185If not supplied the remote given by the default element is used.
@@ -190,6 +199,8 @@ its name:`name` and path:`path`. E.g. for
190definition is implicitly in the following manifest groups: 199definition is implicitly in the following manifest groups:
191default, name:monkeys, and path:barrel-of. If you place a project in the 200default, name:monkeys, and path:barrel-of. If you place a project in the
192group "notdefault", it will not be automatically downloaded by repo. 201group "notdefault", it will not be automatically downloaded by repo.
202If the project has a parent element, the `name` and `path` here
203are the prefixed ones.
193 204
194Element annotation 205Element annotation
195------------------ 206------------------