summaryrefslogtreecommitdiffstats
path: root/docs/manifest-format.md
diff options
context:
space:
mode:
authorRaman Tenneti <rtenneti@google.com>2021-05-04 12:32:13 -0700
committerRaman Tenneti <rtenneti@google.com>2021-05-04 22:36:01 +0000
commit1c3f57e8f13d4f6dc818bdf06c3a40f768ef1ce5 (patch)
treef9bb9fdaa2859f53104b435d0f7d3202337ec1d9 /docs/manifest-format.md
parent05638bf77193d53a8568600345733265e4c6a42c (diff)
downloadgit-repo-1c3f57e8f13d4f6dc818bdf06c3a40f768ef1ce5.tar.gz
manifest_xml: initial support for <contactinfo>
It will be used to let manifest authors self-register contact info. This element can be repeated, and any later entries will clobber earlier ones. This would allow manifest authors who extend manifests to specify their own contact info. It would have 1 required attribute: bugurl. "bugurl" specifies the URL to file a bug against the manifest owner. <contactinfo bugurl="bug-url"/> TODO: This CL only implements the parsing logic and further work will be in followup CLs. Tested the code with the following commands. $ ./run_tests tests/test_manifest_xml.py $ ./run_tests -v Bug: [google internal] b/186220520. Change-Id: I47e765ba2dab5cdf850191129f4d4cd6b803f451 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/305203 Tested-by: Raman Tenneti <rtenneti@google.com> Reviewed-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'docs/manifest-format.md')
-rw-r--r--docs/manifest-format.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/manifest-format.md b/docs/manifest-format.md
index da83d0dd..0752a8cd 100644
--- a/docs/manifest-format.md
+++ b/docs/manifest-format.md
@@ -31,6 +31,7 @@ following DTD:
31 extend-project*, 31 extend-project*,
32 repo-hooks?, 32 repo-hooks?,
33 superproject?, 33 superproject?,
34 contactinfo?,
34 include*)> 35 include*)>
35 36
36 <!ELEMENT notice (#PCDATA)> 37 <!ELEMENT notice (#PCDATA)>
@@ -100,10 +101,13 @@ following DTD:
100 <!ATTLIST repo-hooks in-project CDATA #REQUIRED> 101 <!ATTLIST repo-hooks in-project CDATA #REQUIRED>
101 <!ATTLIST repo-hooks enabled-list CDATA #REQUIRED> 102 <!ATTLIST repo-hooks enabled-list CDATA #REQUIRED>
102 103
103 <!ELEMENT superproject (EMPTY)> 104 <!ELEMENT superproject EMPTY>
104 <!ATTLIST superproject name CDATA #REQUIRED> 105 <!ATTLIST superproject name CDATA #REQUIRED>
105 <!ATTLIST superproject remote IDREF #IMPLIED> 106 <!ATTLIST superproject remote IDREF #IMPLIED>
106 107
108 <!ELEMENT contactinfo EMPTY>
109 <!ATTLIST contactinfo bugurl CDATA #REQUIRED>
110
107 <!ELEMENT include EMPTY> 111 <!ELEMENT include EMPTY>
108 <!ATTLIST include name CDATA #REQUIRED> 112 <!ATTLIST include name CDATA #REQUIRED>
109 <!ATTLIST include groups CDATA #IMPLIED> 113 <!ATTLIST include groups CDATA #IMPLIED>
@@ -405,7 +409,7 @@ Attribute `enabled-list`: List of hooks to use, whitespace or comma separated.
405### Element superproject 409### Element superproject
406 410
407*** 411***
408 *Note*: This is currently a WIP. 412*Note*: This is currently a WIP.
409*** 413***
410 414
411NB: See the [git superprojects documentation]( 415NB: See the [git superprojects documentation](
@@ -424,6 +428,19 @@ same meaning as project's name attribute. See the
424Attribute `remote`: Name of a previously defined remote element. 428Attribute `remote`: Name of a previously defined remote element.
425If not supplied the remote given by the default element is used. 429If not supplied the remote given by the default element is used.
426 430
431### Element contactinfo
432
433***
434*Note*: This is currently a WIP.
435***
436
437This element is used to let manifest authors self-register contact info.
438It has "bugurl" as a required atrribute. This element can be repeated,
439and any later entries will clobber earlier ones. This would allow manifest
440authors who extend manifests to specify their own contact info.
441
442Attribute `bugurl`: The URL to file a bug against the manifest owner.
443
427### Element include 444### Element include
428 445
429This element provides the capability of including another manifest 446This element provides the capability of including another manifest