summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/manifest-format.txt24
1 files changed, 23 insertions, 1 deletions
diff --git a/docs/manifest-format.txt b/docs/manifest-format.txt
index 2b49d466..5c014d6d 100644
--- a/docs/manifest-format.txt
+++ b/docs/manifest-format.txt
@@ -20,7 +20,10 @@ A manifest XML file (e.g. 'default.xml') roughly conforms to the
20following DTD: 20following DTD:
21 21
22<!DOCTYPE manifest [ 22<!DOCTYPE manifest [
23 <!ELEMENT manifest (remote*, default?, project*)> 23 <!ELEMENT manifest (remote*,
24 default?,
25 project*,
26 add-remote*)>
24 27
25 <!ELEMENT remote (EMPTY)> 28 <!ELEMENT remote (EMPTY)>
26 <!ATTLIST remote name ID #REQUIRED> 29 <!ATTLIST remote name ID #REQUIRED>
@@ -37,6 +40,13 @@ following DTD:
37 <!ATTLIST project path CDATA #IMPLIED> 40 <!ATTLIST project path CDATA #IMPLIED>
38 <!ATTLIST project remote IDREF #IMPLIED> 41 <!ATTLIST project remote IDREF #IMPLIED>
39 <!ATTLIST project revision CDATA #IMPLIED> 42 <!ATTLIST project revision CDATA #IMPLIED>
43
44 <!ELEMENT add-remote (EMPTY)>
45 <!ATTLIST add-remote to-project ID #REQUIRED>
46 <!ATTLIST add-remote name ID #REQUIRED>
47 <!ATTLIST add-remote fetch CDATA #REQUIRED>
48 <!ATTLIST add-remote review CDATA #IMPLIED>
49 <!ATTLIST add-remote project-name CDATA #IMPLIED>
40]> 50]>
41 51
42A description of the elements and their attributes follows. 52A description of the elements and their attributes follows.
@@ -74,6 +84,18 @@ Only permitted when the remote element is nested inside of a project
74element (see below). If not given, defaults to the name supplied 84element (see below). If not given, defaults to the name supplied
75in the project's name attribute. 85in the project's name attribute.
76 86
87Element add-remote
88------------------
89
90Adds a remote to an existing project, whose name is given by the
91to-project attribute. This is functionally equivalent to nesting
92a remote element under the project, but has the advantage that it
93can be specified in the uesr's `local_manifest.xml` to add a remote
94to a project declared by the normal manifest.
95
96The element can be used to add a fork of an existing project that
97the user needs to work with.
98
77 99
78Element default 100Element default
79--------------- 101---------------