commit: 688b7114682f9faf594d1aa740de1b6dd9c653ac
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 17:06:29 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec 8 11:32:03 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=688b7114
Elements <brite>, <mail>, and <pkg> are not supported.
Use <c> instead, which seems to be the most appropriate replacement
in their respective contexts.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 2 +-
ebuild-maintenance/maintenance-tasks/text.xml | 16 ++---
ebuild-writing/misc-files/metadata/text.xml | 95 +++++++++++++--------------
3 files changed, 54 insertions(+), 59 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 70fa46a..ee32c9c 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -279,7 +279,7 @@ mirrored by Gentoo is referenced, it will be closed (as
fixed)
automatically with reference to the commit.</li>
<li><c>Package-Manager:</c> This is automatically inserted by
<c>repoman commit</c> and it specifies the version of
-<pkg>sys-apps/portage</pkg> on the system.</li>
+<c>sys-apps/portage</c> on the system.</li>
<li><c>RepoMan-Options:</c> This is automatically inserted by
<c>repoman commit</c> and records the options passed to repoman (such
as --force) for the commit.</li>
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml
b/ebuild-maintenance/maintenance-tasks/text.xml
index 2b16ce3..92dd0a0 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -149,18 +149,16 @@ looking for is not listed then please consult the
relevant lead.
</p>
<p>
-You should <e>never</e> stabilize packages on
-architectures for which you cannot test and instead you should file a bug to
-the relevant architecture team, such as <mail link="sp...@gentoo.org">
-sp...@gentoo.org</mail> asking them to stabilize the
-ebuild. Alternatively, you may be able to find Gentoo developers on
-IRC who could help you with your request.
+You should <e>never</e> stabilize packages on architectures for which you
+cannot test and instead you should file a bug to the relevant architecture
+team, such as <c>sp...@gentoo.org</c> asking them to stabilize the ebuild.
+Alternatively, you may be able to find Gentoo developers on IRC who could help
+you with your request.
</p>
<p>
-It is best to not use <mail link="arch-maintain...@gentoo.org">
-arch-maintain...@gentoo.org</mail>, adding architecture teams onto a
-bug's CC list individually instead. That way teams can remove
+It is best to not use <c>arch-maintain...@gentoo.org</c>, adding architecture
+teams onto a bug's CC list individually instead. That way teams can remove
themselves from the list when they are done, giving a clear indication
of which teams still have to stabilize a package.
</p>
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index 7260e48..a89a512 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -49,71 +49,69 @@ metadata.xml:
</tr>
<tr>
<ti>
- <brite><catmetadata></brite>
+ <c><catmetadata></c>
</ti>
<ti>
This is the root element of the <path>metadata.xml</path> file for
categories. It has no attributes. It contains a number of
- <brite><longdescription></brite> tags, each for a different
- language.
+ <c><longdescription></c> tags, each for a different language.
</ti>
</tr>
<tr>
<ti>
- <brite><pkgmetadata></brite>
+ <c><pkgmetadata></c>
</ti>
<ti>
This is the root element of the <path>metadata.xml</path> file for
packages. It has no attributes. The following subtags are
allowed:
- <brite><longdescription></brite>,
- <brite><maintainer></brite>,
- <brite><slots></brite>,
- <brite><use></brite>, and
- <brite><upstream></brite>.
+ <c><longdescription></c>,
+ <c><maintainer></c>,
+ <c><slots></c>,
+ <c><use></c>, and
+ <c><upstream></c>.
While all the subtags are optional, <upstream> may
appear at most once.
</ti>
</tr>
<tr>
- <ti><brite><longdescription></brite></ti>
+ <ti><c><longdescription></c></ti>
<ti>
This tag contains a description for a category or a package. For
packages, it is used to augment the
<uri link="::ebuild-writing/variables#ebuild-defined-variables">
DESCRIPTION</uri> field in the ebuilds themselves. This tag has
- two optional subtags: <brite><pkg></brite> and
- <brite><cat></brite>.
+ two optional subtags: <c><pkg></c> and <c><cat></c>.
</ti>
</tr>
<tr>
<ti>
- <brite><maintainer></brite>
+ <c><maintainer></c>
</ti>
<ti>
This tag specifies the persons and/or projects responsible for
the maintenance of a package. The <c>type</c> attribute must
- be specified and can be either <c>"person"</c> or
- <c>"project"</c>. There is one required subtag:
- <brite><email></brite>. It has two optional subtags:
- <brite><name></brite> and
- <brite><description></brite>.
+ be specified and can be either <c>"person"</c> or <c>"project"</c>.
+ There is one required subtag:
+ <c><email></c>. It has two optional subtags:
+ <c><name></c> and
+ <c><description></c>.
</ti>
</tr>
<tr>
- <ti><brite><email></brite></ti>
+ <ti><c><email></c></ti>
<ti>
This contains the e-mail address of the maintainer. It is required.
</ti>
</tr>
<tr>
- <ti><brite><name></brite></ti>
+ <ti><c><name></c></ti>
<ti>
This contains freetext with the name of the maintainer. It is optional.
</ti>
</tr>
<tr>
- <ti><brite><description></brite></ti>
+ <ti><c><description></c></ti>
<ti>
The description tag contains a description of the maintainership, or for
example a remark that someone interested can take over the maintainership.
@@ -121,7 +119,7 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><slots></brite></ti>
+ <ti><c><slots></c></ti>
<ti>
This tag describes the
<uri link="::general-concepts/slotting">slots</uri> of a package.
@@ -129,40 +127,40 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><slot></brite></ti>
+ <ti><c><slot></c></ti>
<ti>
This contains information for a particular slot. The <c>name</c>
attribute is mandatory and specifies the name of the slot.
</ti>
</tr>
<tr>
- <ti><brite><subslots></brite></ti>
+ <ti><c><subslots></c></ti>
<ti>
Describes the meaning of subslots for the whole package. This
tag may appear at most once.
</ti>
</tr>
<tr>
- <ti><brite><use></brite></ti>
+ <ti><c><use></c></ti>
<ti>
This tag contains descriptions of <uri
link="::ebuild-writing/variables#iuse">USE flags</uri>.
This tag is optional and, if specified, has one required subtag:
- <brite><flag></brite>.
+ <c><flag></c>.
</ti>
</tr>
<tr>
- <ti><brite><flag></brite></ti>
+ <ti><c><flag></c></ti>
<ti>
This tag contains a description of how the named USE flag affects this
- package. It is required if the <brite><use></brite> tag is specified.
+ package. It is required if the <c><use></c> tag is specified.
It also requires the USE flag to be named in the <c>name</c> attribute.
- This tag has two optional subtags: <brite><pkg></brite> and
- <brite><cat></brite>.
+ This tag has two optional subtags: <c><pkg></c> and
+ <c><cat></c>.
</ti>
</tr>
<tr>
- <ti><brite><upstream></brite></ti>
+ <ti><c><upstream></c></ti>
<ti>
This tag contains information about the upstream developers/project.
It supports multiple optional subtags: <maintainer>,
@@ -171,7 +169,7 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><maintainer></brite></ti>
+ <ti><c><maintainer></c></ti>
<ti>
Provides information about the upstream maintainer. It requires a
<name> subtag to be specified, supports an optional
@@ -179,20 +177,20 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><name></brite></ti>
+ <ti><c><name></c></ti>
<ti>
The name of an upstream maintainer should contain a block of text with
upstream's name.
This element is mandatory for an upstream maintainer and must appear
exactly once.
</ti>
</tr>
<tr>
- <ti><brite><email></brite></ti>
+ <ti><c><email></c></ti>
<ti>
The email address of an upstream maintainer. May appear only once.
</ti>
</tr>
<tr>
- <ti><brite><changelog></brite></ti>
+ <ti><c><changelog></c></ti>
<ti>
Should contain a URL where the location of the upstream changelog can be
found.
The URL must be version independent and must point to a changelog which is
only
@@ -202,7 +200,7 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><doc></brite></ti>
+ <ti><c><doc></c></ti>
<ti>
Should contain a URL where the location of the upstream documentation can
be
found. The link must not point to any third party documentation and must be
@@ -212,14 +210,14 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><bugs-to></brite></ti>
+ <ti><c><bugs-to></c></ti>
<ti>
Should contain a place where bugs can be filed, a URL or an e-mail address
prefixed
with <c>mailto:</c>. May appear at most once.
</ti>
</tr>
<tr>
- <ti><brite><remote-id></brite></ti>
+ <ti><c><remote-id></c></ti>
<ti>
Should specify a type of package identification tracker and the
identification that
corresponds to the package in question. remote-id should make it easier to
index
@@ -229,13 +227,13 @@ metadata.xml:
</ti>
</tr>
<tr>
- <ti><brite><pkg></brite></ti>
+ <ti><c><pkg></c></ti>
<ti>
This tag contains a valid qualified package name.
</ti>
</tr>
<tr>
- <ti><brite><cat></brite></ti>
+ <ti><c><cat></c></ti>
<ti>
This tag contains a valid category name as defined in
<path>profiles/categories</path>.
@@ -256,9 +254,8 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>lang</ti>
<ti>
- <brite><description></brite>, <brite><longdescription></brite>,
- <brite><slots></brite>,
- <brite><use></brite>, <brite><doc></brite>
+ <c><description></c>, <c><longdescription></c>,
+ <c><slots></c>, <c><use></c>, <c><doc></c>
</ti>
<ti>
In every case where a description is required, there must be at
@@ -272,8 +269,8 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>restrict</ti>
<ti>
- <brite><maintainer></brite>,
- <brite><longdescription></brite>, <brite><flag></brite>
+ <c><maintainer></c>,
+ <c><longdescription></c>, <c><flag></c>
</ti>
<ti>
The restrict attribute allows one to restrict the application of
@@ -289,7 +286,7 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>name</ti>
<ti>
- <brite><flag></brite>, <brite><slot></brite>
+ <c><flag></c>, <c><slot></c>
</ti>
<ti>
When this attribute is required on the <flag> tag, it
@@ -304,7 +301,7 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>status</ti>
<ti>
- <brite><maintainer></brite>
+ <c><maintainer></c>
</ti>
<ti>
The upstream maintainer element has a status attribute, which is
@@ -318,7 +315,7 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>type</ti>
<ti>
- <brite><remote-id></brite>
+ <c><remote-id></c>
</ti>
<ti>
A string identifying the type of upstream source. A list of valid strings
are kept in
@@ -329,7 +326,7 @@ There are also some attributes that can be used with these
tags:
<tr>
<ti>type</ti>
<ti>
- <brite><maintainer></brite>
+ <c><maintainer></c>
</ti>
<ti>
Defines the type of the maintainer for a package. There are only
