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