commit: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Jan 12 05:00:05 2022 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 12 06:28:56 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=434e6c60
ebuild-writing/misc-files/metadata: fix formatting, use <c> tags consistently
Signed-off-by: Sam James <sam <AT> gentoo.org>
[Whitespace changes]
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 41 +++++++++++++++--------------
1 file changed, 21 insertions(+), 20 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index 416167c..a961821 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -132,7 +132,8 @@ metadata.xml:
<ti>
This tag describes the
<uri link="::general-concepts/slotting">slots</uri> of a package.
- It has two optional subtags: <slot> and <subslots>.
+ It has two optional subtags:
+ <c><slot></c> and <c><subslots></c>.
</ti>
</tr>
<tr>
@@ -172,17 +173,17 @@ metadata.xml:
<ti><c><upstream></c></ti>
<ti>
This tag contains information about the upstream developers/project.
- It supports multiple optional subtags: <maintainer>,
- <changelog>, <doc>, <bugs-to>,
- and <remote-id>.
+ It supports multiple optional subtags: <c><maintainer></c>,
+ <c><changelog></c>, <c><doc></c>,
+ <c><bugs-to>,</c>, and <c><remote-id></c>.
</ti>
</tr>
<tr>
<ti><c><maintainer></c></ti>
<ti>
Provides information about the upstream maintainer. It requires a
- <name> subtag to be specified, supports an optional
- <email> subtag and an optional <c>status</c> attribute.
+ <c><name></c> subtag to be specified, supports an optional
+ <c><email></c> subtag and an optional <c>status</c> attribute.
Note that the <c>type</c> attribute <e>must not</e> be specified
for upstream maintainers.
</ti>
@@ -217,7 +218,7 @@ metadata.xml:
found. The link must not point to any third party documentation and must be
version independent. If the documentation is available in more than one
language,
a lang attribute can be used which follows the same rules as the one for
- <longdescription>.
+ <c><longdescription></c>.
</ti>
</tr>
<tr>
@@ -301,12 +302,12 @@ There are also some attributes that can be used with
these tags:
<c><flag></c>, <c><slot></c>
</ti>
<ti>
- When this attribute is required on the <flag> tag, it
+ When this attribute is required on the <c><flag></c> tag, it
simply contains the name of the USE flag. For the
- <slot> tag, it specifies the
+ <c><slot></c> tag, it specifies the
<uri link="::general-concepts/slotting/#Slot Names">
slot name</uri> to which it applies. A slot name of <c>*</c>
- allows for a single <slot> tag to match all the slots of a
+ allows for a single <c><slot></c> tag to match all the slots of a
package, in which case no other slot tags may be present.
</ti>
</tr>
@@ -320,7 +321,7 @@ There are also some attributes that can be used with these
tags:
one of <c>"active"</c> or <c>"inactive"</c>. This attribute is not
mandatory. The absence of it shall be interpreted as
<c>"unknown"</c>. Please note that this attribute is only allowed
- for the <maintainer> subtags of the <upstream>
+ for the <c><maintainer></c> subtags of the <c><upstream></c>
element!
</ti>
</tr>
@@ -405,7 +406,7 @@ presented. It is a simplified version of
<c>metadata.xml</c> for
the package <c>app-office/libreoffice</c>. The package
maintainer is identified by the email address <c>[email protected]</c>
with the name <c>Gentoo Office Project</c> as specified in the
-optional <name> subtag. It also provides a long package
+optional <c><name></c> subtag. It also provides a long package
description.
</p>
@@ -470,9 +471,9 @@ The second example is formed after the <c>metadata.xml</c>
of
is a developer and the other is a project. It illustrates how local
USE flag descriptions are specified and also contains an upstream
element. It is also worth pointing out the use of <c>mailto:</c>
-prefix in <bugs-to> tag due to the presence of an email address
+prefix in <c><bugs-to></c> tag due to the presence of an email address
as opposed to a URL. Conversely, email addresses specified in the
-<email> tags require no such prefix.
+<c><email></c> tags require no such prefix.
</p>
<codesample lang="sgml">
@@ -524,9 +525,9 @@ project. Note the use of "&gt;" as opposed to ">" in
<p>
The example also uses the <c><pkg></c> tag in USE flag
descriptions. Slot dependency specifiers are not allowed inside
-<pkg>, therefore the notation
-<pkg>sys-boot/grub</pkg><c>:2</c> is adopted as opposed to
-<pkg>sys-boot/grub<c>:2</c></pkg>.
+<c><pkg></c>, therefore the notation
+<c><pkg>sys-boot/grub</pkg>:2</c> is adopted as opposed to
+<c><pkg>sys-boot/grub:2</pkg></c>.
</p>
<p>
@@ -635,9 +636,9 @@ specified in the <c><subslots></c> tag.
Maintainer-needed, or orphaned, packages have no maintainers
responsible for them. Per
<uri
link="https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages";>
-GLEP 67</uri>, these packages must not contain any <maintainer>
-subtags under <pkgmetadata> in their <c>metadata.xml</c>. A strict test
-for this condition would be:
+GLEP 67</uri>, these packages must not contain any <c><maintainer></c>
+subtags under <c><pkgmetadata></c> in their <c>metadata.xml</c>. A strict
+test for this condition would be:
</p>
<pre>
