Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 234730 | Differences between
and this patch

Collapse All | Expand All

(-)hb-guide-metadata.xml (-2 / +113 lines)
Line 142 Link Here
142
  <ti><brite>&lt;upstream&gt;</brite></ti>
143
  <ti>
144
    This tag contains information about the upstream developers/project.
145
  </ti>
146
</tr>
147
<tr>
148
  <ti><brite>&lt;maintainer&gt;</brite></ti>
149
  <ti>
150
    Name and e-mail of an upstream maintainer. May appear more than once.
151
  </ti>
152
</tr>
153
<tr>
154
  <ti><brite>&lt;name&gt;</brite></ti>
155
  <ti>
156
    The name of an usptream maintainer should contain a block of text with upstream's name.
157
    This element is mandatory for an upstream maintainer and must appear only once.
158
  </ti>
159
</tr>
160
<tr>
161
  <ti><brite>&lt;email&gt;</brite></ti>
162
  <ti>
163
    The email address of an upstream may appear only once.
164
  </ti>
165
</tr>
166
<tr>
167
  <ti><brite>&lt;changelog&gt;</brite></ti>
168
  <ti>
169
    Should contain a URL where the location of the upstream changelog can be found.
170
    The URL must be version independent and must point to a changelog which is only
171
    updated on new releases of the corresponding package. (This also implies that
172
    one can link to an automatically updated changelog in case of vcs snapshots
173
    only.)
174
  </ti>
175
</tr>
176
<tr>
177
  <ti><brite>&lt;doc&gt;</brite></ti>
178
  <ti>
179
    Should contain a URL where the location of the upstream documentation can be
180
    found. The link must not point to any third party documentation and must be
181
    version independent. If the documentation is available in more than one language,
182
    a lang attribute can be used which follows the same rules as the one for
183
    longdescription.
184
  </ti>
185
</tr>
186
<tr>
187
  <ti><brite>&lt;bugs-to&gt;</brite></ti>
188
  <ti>
189
    Should contain a place where bugs can be filed, a URL or an e-mail address prefixed
190
    with mailto:.
191
  </ti>
192
</tr>
193
<tr>
194
  <ti><brite>&lt;remote-id&gt;</brite></ti>
195
  <ti>
196
    Should specify a type of package identification tracker and the identification that
197
    corresponds to the package in question. remote-id should make it easier to index
198
    information such as its Freshmeat ID or its CPAN name.
199
  </ti>
200
</tr>
201
<tr>
Line 171 Link Here
171
    <brite>&lt;use&gt;</brite>
231
    <brite>&lt;use&gt;</brite>, <brite>&lt;doc&gt;</brite>
172
--
Line 215 Link Here
275
<tr>
276
  <ti>status</ti>
277
  <ti>
278
    <brite>&lt;maintainer&gt;</brite>
279
  </ti>
280
  <ti>
281
    The upstream maintainer element has a status attribute, which is one of active or inactive.
282
    This attribute is not mandatory. The absence of it shall be interpreted as unknown.
283
    Please note: This attribute is only allowed in the &lt;upstream&gt; &lt;maintainer&gt; element!
284
  </ti>
285
</tr>
286
<tr>
287
  <ti>type</ti>
288
  <ti>
289
    <brite>&lt;remote-id&gt;</brite>
290
  </ti>
291
  <ti>
292
    A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd.
293
    Developers should email the gentoo-dev mailing list before using a new type value. 
294
  </ti>
295
</tr>
296
Line 360 Link Here
442
443
<subsection>
444
<title>Fourth Example</title>
445
<body>
446
447
<p>
448
This example demonstrates the usage of the upstream element
449
</p>
450
451
<pre caption="Upstream description">
452
&lt;upstream&gt;
453
        &lt;maintainer status="inactive"&gt;
454
                &lt;name&gt;Foo Bar&lt;/name&gt;
455
                &lt;email&gt;foo@bar.bar&lt;/email&gt;
456
        &lt;/maintainer&gt;
457
        &lt;maintainer status="active"&gt;
458
                &lt;name&gt;Foo Gentoo&lt;/name&gt;
459
                &lt;email&gt;foo@gentoo.org&lt;/email&gt;
460
        &lt;/maintainer&gt;
461
        &lt;changelog&gt;http://foo.bar/changelog.txt&lt;/changelog&gt;
462
        &lt;doc lang="en"&gt;http://foo.bar/doc/index.html&lt;/doc&gt;
463
        &lt;doc lang="de"&gt;http://foo.bar/doc/index.de.html&lt;/doc&gt;
464
        &lt;bugs-to&gt;https://bugs.foo.bar&lt;/bugs-to&gt;
465
        &lt;remote-id type="freshmeat"&gt;foobar&lt;/remote-id&gt;
466
        &lt;remote-id type="sourceforge"&gt;foobar&lt;/remote-id&gt;
467
&lt;/upstream&gt;
468
</pre>
469
470
</subsection>
471

Return to bug 234730