summaryrefslogtreecommitdiffstats
path: root/docs/manifest-format.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manifest-format.md')
-rw-r--r--docs/manifest-format.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/docs/manifest-format.md b/docs/manifest-format.md
index 6156333a..aa1580d9 100644
--- a/docs/manifest-format.md
+++ b/docs/manifest-format.md
@@ -252,12 +252,25 @@ name will be prefixed by the parent's.
252The project name must match the name Gerrit knows, if Gerrit is 252The project name must match the name Gerrit knows, if Gerrit is
253being used for code reviews. 253being used for code reviews.
254 254
255"name" must not be empty, and may not be an absolute path or use "." or ".."
256path components. It is always interpreted relative to the remote's fetch
257settings, so if a different base path is needed, declare a different remote
258with the new settings needed.
259These restrictions are not enforced for [Local Manifests].
260
255Attribute `path`: An optional path relative to the top directory 261Attribute `path`: An optional path relative to the top directory
256of the repo client where the Git working directory for this project 262of the repo client where the Git working directory for this project
257should be placed. If not supplied the project name is used. 263should be placed. If not supplied the project "name" is used.
258If the project has a parent element, its path will be prefixed 264If the project has a parent element, its path will be prefixed
259by the parent's. 265by the parent's.
260 266
267"path" may not be an absolute path or use "." or ".." path components.
268These restrictions are not enforced for [Local Manifests].
269
270If you want to place files into the root of the checkout (e.g. a README or
271Makefile or another build script), use the [copyfile] or [linkfile] elements
272instead.
273
261Attribute `remote`: Name of a previously defined remote element. 274Attribute `remote`: Name of a previously defined remote element.
262If not supplied the remote given by the default element is used. 275If not supplied the remote given by the default element is used.
263 276
@@ -419,12 +432,15 @@ target manifest to include - it must be a usable manifest on its own.
419Attribute `name`: the manifest to include, specified relative to 432Attribute `name`: the manifest to include, specified relative to
420the manifest repository's root. 433the manifest repository's root.
421 434
435"name" may not be an absolute path or use "." or ".." path components.
436These restrictions are not enforced for [Local Manifests].
437
422Attribute `groups`: List of additional groups to which all projects 438Attribute `groups`: List of additional groups to which all projects
423in the included manifest belong. This appends and recurses, meaning 439in the included manifest belong. This appends and recurses, meaning
424all projects in sub-manifests carry all parent include groups. 440all projects in sub-manifests carry all parent include groups.
425Same syntax as the corresponding element of `project`. 441Same syntax as the corresponding element of `project`.
426 442
427## Local Manifests 443## Local Manifests {#local-manifests}
428 444
429Additional remotes and projects may be added through local manifest 445Additional remotes and projects may be added through local manifest
430files stored in `$TOP_DIR/.repo/local_manifests/*.xml`. 446files stored in `$TOP_DIR/.repo/local_manifests/*.xml`.
@@ -452,3 +468,8 @@ Manifest files stored in `$TOP_DIR/.repo/local_manifests/*.xml` will
452be loaded in alphabetical order. 468be loaded in alphabetical order.
453 469
454The legacy `$TOP_DIR/.repo/local_manifest.xml` path is no longer supported. 470The legacy `$TOP_DIR/.repo/local_manifest.xml` path is no longer supported.
471
472
473[copyfile]: #Element-copyfile
474[linkfile]: #Element-linkfile
475[Local Manifests]: #local-manifests