From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 0412C158088 for ; Wed, 12 Jan 2022 06:34:10 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 1CC9E2BC04F; Wed, 12 Jan 2022 06:34:09 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id C18DF2BC058 for ; Wed, 12 Jan 2022 06:34:08 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 8DCB43430B1 for ; Wed, 12 Jan 2022 06:34:07 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 06971295 for ; Wed, 12 Jan 2022 06:34:06 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1641968936.434e6c60110c6bde6edbfd2081f2a6a913cb67e1.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/ X-VCS-Repository: proj/devmanual X-VCS-Files: ebuild-writing/misc-files/metadata/text.xml X-VCS-Directories: ebuild-writing/misc-files/metadata/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1 X-VCS-Branch: master Date: Wed, 12 Jan 2022 06:34:06 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 75a10bcf-8a07-4480-b187-cbf1be2af447 X-Archives-Hash: 827697555ab1a77c6569c6003beb3499 commit: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 05:00:05 2022 +0000 Commit: Ulrich Müller gentoo 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 tags consistently Signed-off-by: Sam James gentoo.org> [Whitespace changes] Signed-off-by: Ulrich Müller 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: This tag describes the slots of a package. - It has two optional subtags: <slot> and <subslots>. + It has two optional subtags: + <slot> and <subslots>. @@ -172,17 +173,17 @@ metadata.xml: <upstream> 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: <maintainer>, + <changelog>, <doc>, + <bugs-to>,, and <remote-id>. <maintainer> Provides information about the upstream maintainer. It requires a - <name> subtag to be specified, supports an optional - <email> subtag and an optional status attribute. + <name> subtag to be specified, supports an optional + <email> subtag and an optional status attribute. Note that the type attribute must not be specified for upstream maintainers. @@ -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>. + <longdescription>. @@ -301,12 +302,12 @@ There are also some attributes that can be used with these tags: <flag>, <slot> - When this attribute is required on the <flag> tag, it + When this attribute is required on the <flag> tag, it simply contains the name of the USE flag. For the - <slot> tag, it specifies the + <slot> tag, it specifies the slot name to which it applies. A slot name of * - allows for a single <slot> tag to match all the slots of a + allows for a single <slot> tag to match all the slots of a package, in which case no other slot tags may be present. @@ -320,7 +321,7 @@ There are also some attributes that can be used with these tags: one of "active" or "inactive". This attribute is not mandatory. The absence of it shall be interpreted as "unknown". Please note that this attribute is only allowed - for the <maintainer> subtags of the <upstream> + for the <maintainer> subtags of the <upstream> element! @@ -405,7 +406,7 @@ presented. It is a simplified version of metadata.xml for the package app-office/libreoffice. The package maintainer is identified by the email address office@gentoo.org with the name Gentoo Office Project as specified in the -optional <name> subtag. It also provides a long package +optional <name> subtag. It also provides a long package description.

@@ -470,9 +471,9 @@ The second example is formed after the metadata.xml 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 mailto: -prefix in <bugs-to> tag due to the presence of an email address +prefix in <bugs-to> 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. +<email> tags require no such prefix.

@@ -524,9 +525,9 @@ project. Note the use of "&gt;" as opposed to ">" in

The example also uses the <pkg> tag in USE flag descriptions. Slot dependency specifiers are not allowed inside -<pkg>, therefore the notation -<pkg>sys-boot/grub</pkg>:2 is adopted as opposed to -<pkg>sys-boot/grub:2</pkg>. +<pkg>, therefore the notation +<pkg>sys-boot/grub</pkg>:2 is adopted as opposed to +<pkg>sys-boot/grub:2</pkg>.

@@ -635,9 +636,9 @@ specified in the <subslots> tag. Maintainer-needed, or orphaned, packages have no maintainers responsible for them. Per -GLEP 67, these packages must not contain any <maintainer> -subtags under <pkgmetadata> in their metadata.xml. A strict test -for this condition would be: +GLEP 67, these packages must not contain any <maintainer> +subtags under <pkgmetadata> in their metadata.xml. A strict +test for this condition would be: