diff options
| author | Shawn O. Pearce <sop@google.com> | 2009-03-04 14:26:50 -0800 |
|---|---|---|
| committer | Shawn O. Pearce <sop@google.com> | 2009-03-04 14:26:50 -0800 |
| commit | 43c3d9ea17f1436a6b3b2e7e7827da6f48a21da9 (patch) | |
| tree | 9bfa77f57095fcd04901ee7783c78d49afdb1e9d /docs/manifest-format.txt | |
| parent | 4259b8a2ac0dddb54e98e00afc454bf966d4f058 (diff) | |
| download | git-repo-43c3d9ea17f1436a6b3b2e7e7827da6f48a21da9.tar.gz | |
Add a 'repo manifest' command whose help is the manifest file format
This should make it easier for users to discover the file format
on their own, and read about it.
Signed-off-by: Shawn O. Pearce <sop@google.com>
Diffstat (limited to 'docs/manifest-format.txt')
| -rw-r--r-- | docs/manifest-format.txt | 84 |
1 files changed, 41 insertions, 43 deletions
diff --git a/docs/manifest-format.txt b/docs/manifest-format.txt index 562e66e2..89257b8b 100644 --- a/docs/manifest-format.txt +++ b/docs/manifest-format.txt | |||
| @@ -19,39 +19,39 @@ XML File Format | |||
| 19 | A manifest XML file (e.g. 'default.xml') roughly conforms to the | 19 | A manifest XML file (e.g. 'default.xml') roughly conforms to the |
| 20 | following DTD: | 20 | following DTD: |
| 21 | 21 | ||
| 22 | <!DOCTYPE manifest [ | 22 | <!DOCTYPE manifest [ |
| 23 | <!ELEMENT manifest (remote*, | 23 | <!ELEMENT manifest (remote*, |
| 24 | default?, | 24 | default?, |
| 25 | remove-project*, | 25 | remove-project*, |
| 26 | project*, | 26 | project*, |
| 27 | add-remote*)> | 27 | add-remote*)> |
| 28 | 28 | ||
| 29 | <!ELEMENT remote (EMPTY)> | 29 | <!ELEMENT remote (EMPTY)> |
| 30 | <!ATTLIST remote name ID #REQUIRED> | 30 | <!ATTLIST remote name ID #REQUIRED> |
| 31 | <!ATTLIST remote fetch CDATA #REQUIRED> | 31 | <!ATTLIST remote fetch CDATA #REQUIRED> |
| 32 | <!ATTLIST remote review CDATA #IMPLIED> | 32 | <!ATTLIST remote review CDATA #IMPLIED> |
| 33 | <!ATTLIST remote project-name CDATA #IMPLIED> | 33 | <!ATTLIST remote project-name CDATA #IMPLIED> |
| 34 | 34 | ||
| 35 | <!ELEMENT default (EMPTY)> | 35 | <!ELEMENT default (EMPTY)> |
| 36 | <!ATTLIST default remote IDREF #IMPLIED> | 36 | <!ATTLIST default remote IDREF #IMPLIED> |
| 37 | <!ATTLIST default revision CDATA #IMPLIED> | 37 | <!ATTLIST default revision CDATA #IMPLIED> |
| 38 | 38 | ||
| 39 | <!ELEMENT project (remote*)> | 39 | <!ELEMENT project (remote*)> |
| 40 | <!ATTLIST project name CDATA #REQUIRED> | 40 | <!ATTLIST project name CDATA #REQUIRED> |
| 41 | <!ATTLIST project path CDATA #IMPLIED> | 41 | <!ATTLIST project path CDATA #IMPLIED> |
| 42 | <!ATTLIST project remote IDREF #IMPLIED> | 42 | <!ATTLIST project remote IDREF #IMPLIED> |
| 43 | <!ATTLIST project revision CDATA #IMPLIED> | 43 | <!ATTLIST project revision CDATA #IMPLIED> |
| 44 | 44 | ||
| 45 | <!ELEMENT add-remote (EMPTY)> | 45 | <!ELEMENT add-remote (EMPTY)> |
| 46 | <!ATTLIST add-remote to-project ID #REQUIRED> | 46 | <!ATTLIST add-remote to-project ID #REQUIRED> |
| 47 | <!ATTLIST add-remote name ID #REQUIRED> | 47 | <!ATTLIST add-remote name ID #REQUIRED> |
| 48 | <!ATTLIST add-remote fetch CDATA #REQUIRED> | 48 | <!ATTLIST add-remote fetch CDATA #REQUIRED> |
| 49 | <!ATTLIST add-remote review CDATA #IMPLIED> | 49 | <!ATTLIST add-remote review CDATA #IMPLIED> |
| 50 | <!ATTLIST add-remote project-name CDATA #IMPLIED> | 50 | <!ATTLIST add-remote project-name CDATA #IMPLIED> |
| 51 | 51 | ||
| 52 | <!ELEMENT remove-project (EMPTY)> | 52 | <!ELEMENT remove-project (EMPTY)> |
| 53 | <!ATTLIST remove-project name CDATA #REQUIRED> | 53 | <!ATTLIST remove-project name CDATA #REQUIRED> |
| 54 | ]> | 54 | ]> |
| 55 | 55 | ||
| 56 | A description of the elements and their attributes follows. | 56 | A description of the elements and their attributes follows. |
| 57 | 57 | ||
| @@ -179,16 +179,14 @@ manifest, stored in `$TOP_DIR/.repo/local_manifest.xml`. | |||
| 179 | 179 | ||
| 180 | For example: | 180 | For example: |
| 181 | 181 | ||
| 182 | ---- | 182 | $ cat .repo/local_manifest.xml |
| 183 | $ cat .repo/local_manifest.xml | 183 | <?xml version="1.0" encoding="UTF-8"?> |
| 184 | <?xml version="1.0" encoding="UTF-8"?> | 184 | <manifest> |
| 185 | <manifest> | 185 | <project path="manifest" |
| 186 | <project path="manifest" | 186 | name="tools/manifest" /> |
| 187 | name="tools/manifest" /> | 187 | <project path="platform-manifest" |
| 188 | <project path="platform-manifest" | 188 | name="platform/manifest" /> |
| 189 | name="platform/manifest" /> | 189 | </manifest> |
| 190 | </manifest> | ||
| 191 | ---- | ||
| 192 | 190 | ||
| 193 | Users may add projects to the local manifest prior to a `repo sync` | 191 | Users may add projects to the local manifest prior to a `repo sync` |
| 194 | invocation, instructing repo to automatically download and manage | 192 | invocation, instructing repo to automatically download and manage |