[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: f599228d19e81efb54e606c52a1562b857d71929 Author: Ulrich Müller gentoo org> AuthorDate: Fri May 27 10:15:49 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 10:15:49 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f599228d ebuild-writing/misc-files/metadata: Update restrict attribute The description currently says: "When this attribute is used, other tags with or without the restrict attribute must be present to cover all the versions of the package. A tag without the restrict attribute serves as the default." However, this is not reflected by the specification in GLEP 68. It appears to have originated from the old DevRel Handbook where it had been added in 2004: https://gitweb.gentoo.org/archive/proj/gentoo.git/tree/xml/htdocs/proj/en/devrel/handbook/hb-guide-metadata.xml?id=26d18f5f20f00e538b7af0d5a795008f3426d243#n135 Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 15 ++- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index bcc43f4..9c6bd76 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -285,15 +285,12 @@ There are also some attributes that can be used with these tags: stabilize-allarches, flag -The restrict attribute allows one to restrict the application of -certain tags to certain versions of a package. When this attribute -is used, other tags with or without the restrict attribute must be -present to cover all the versions of the package. A tag without -the restrict attribute serves as the default. The format of the -restrict attribute is that of a EAPI=0 package dependency specification -(i.e., USE-conditional or slot dependendencies are not allowed). -Since and are special characters in XML, -they must be escaped using lt; and gt;. +The restrict attribute allows one to restrict the application of certain +tags to certain versions of a package. The format of the restrict attribute +is that of a EAPI 0 package dependency specification (i.e. USE-conditional +or slot dependendencies are not allowed). Since and +are special characters in XML, they must be escaped using lt; +and gt;.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 389882dac0cb2e2a174cf70fdad778b71a4538d3 Author: Ulrich Müller gentoo org> AuthorDate: Sun May 22 06:24:57 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 09:02:31 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=389882da ebuild-writing/misc-files/metadata: Language tags can be BCP 47 This corresponds to the update of GLEP 68. Bug: https://bugs.gentoo.org/578294 Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index e24be93..bcc43f4 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -273,9 +273,9 @@ There are also some attributes that can be used with these tags: In every case where a description is required, there must be at least an english description. If an additional description in another language is given, this attribute is used to specify the language -used. The format is the two-character language code as defined by the https://www.w3.org/WAI/ER/IG/ert/iso639.htm#2letter;>ISO-639-1 -norm. +used. The format is an IETF language tag as defined by the +https://tools.ietf.org/rfc/bcp/bcp47.txt;>BCP 47 +specification. Most often, this will be a two-character language code.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/, general-concepts/manifest/, ...
commit: c2c0b163b73c53d8aa65ed6403bdf8f116ef45b8
Author: Matt Turner gentoo org>
AuthorDate: Fri Mar 11 21:12:26 2022 +
Commit: Matt Turner gentoo org>
CommitDate: Mon Mar 14 17:05:41 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c2c0b163
Remove references to repoman
Bug: https://bugs.gentoo.org/835013
Closes: https://github.com/gentoo/devmanual/pull/274
Signed-off-by: Matt Turner gentoo.org>
appendices/common-problems/text.xml| 2 +-
appendices/editor-configuration/emacs/text.xml | 4 +--
ebuild-maintenance/git/text.xml| 39 +++---
ebuild-maintenance/new-ebuild/text.xml | 8 +++---
ebuild-writing/common-mistakes/text.xml| 4 +--
ebuild-writing/file-format/text.xml| 6 ++--
ebuild-writing/misc-files/metadata/text.xml| 2 +-
eclass-writing/text.xml| 3 +-
general-concepts/ebuild-revisions/text.xml | 5 ++--
general-concepts/manifest/text.xml | 7 ++---
keywording/text.xml| 12 +---
tools-reference/text.xml | 3 --
12 files changed, 35 insertions(+), 60 deletions(-)
diff --git a/appendices/common-problems/text.xml
b/appendices/common-problems/text.xml
index 4fcdda4..d124070 100644
--- a/appendices/common-problems/text.xml
+++ b/appendices/common-problems/text.xml
@@ -161,7 +161,7 @@ directories Executable stacks ... binary files whose stack
is marked with
-Handling repoman Messages
+Handling pkgcheck Messages
diff --git a/appendices/editor-configuration/emacs/text.xml
b/appendices/editor-configuration/emacs/text.xml
index f822388..c90dba6 100644
--- a/appendices/editor-configuration/emacs/text.xml
+++ b/appendices/editor-configuration/emacs/text.xml
@@ -50,9 +50,7 @@ automatically before saving the file.
Other useful settings can be disabled backup files
(by (setq make-backup-files nil)), so you don't clutter the git
-repository
-directories and confuse repoman with it (by adding unnecessary entries
-into a Manifest file e.g.). Emacs can even contact the outside world
+repository directories. Emacs can even contact the outside world
by using the X servers clipboard abilities when yanking, which is
activated by (setq x-select-enable-clipboard t).
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index cf8d6ba..01a4da0 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -112,11 +112,10 @@ the historical commits after the initial git commit.
-The recommended way of committing to the Gentoo repository is to use repoman
-commit or pkgdev commit (then pkgdev push). It automatically
-performs the necessary QA checks on the package being committed and has other
-features helping with the Gentoo workflow. However, repoman is currently
-limited to creating a single commit to a single package.
+The recommended way of committing to the Gentoo repository is to use pkgdev
+commit (then pkgdev push). It automatically performs the necessary
+QA checks on the package being committed and has other features helping with
+the Gentoo workflow.
@@ -130,21 +129,19 @@ used. The valid uses of git include:
Gentoo repository (eclasses, licenses, profiles…),
-amending a commit created via repoman commit or pkgdev commit
-with additional files or fixups,
+amending a commit created via pkgdev commit with additional files
+or fixups,
-combining multiple commits created via repoman commit or
-pkgdev commit using git rebase.
+combining multiple commits created via pkgdev commit using
+git rebase.
-Whenever repoman or pkgdev is not used to commit, you need to
-manually verify all packages affected by the commit using repoman full
or
-pkgcheck scan --commits. When using repoman, it won't be aware of
-staged changes, so ensure that all files are included in the commit.
-Also, when using git manually, you must perform a manual sign-off to the
+Whenever pkgdev is not used to commit, you need to manually verify all
+packages affected by the commit using pkgcheck scan --commits. Also,
+when using git manually, you must perform a manual sign-off to the
using
the -s or --signoff option with your git commit commands. Make
sure you have read and understand the actual certificate.
@@ -224,8 +221,8 @@ appropriately:
-${CATEGORY}/${PN}: Single Package (Note that repoman commit
-and pkgdev commit will automatically insert this for you)
+${CATEGORY}/${PN}: Single Package (Note that pkgdev commit
+will automatically insert this for you)
${CATEGORY}: Package Category
profiles: Profile Directory
@@ -286,15 +283,11 @@ are optionally used in Gentoo:
referenced, it will be closed (as fixed) automatically with reference
to the commit.
-
-Package-Manager: This is automatically inserted by
-repoman
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 05:00:05 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:56 2022 + 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 off...@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 -pkgsys-boot/grub/pkg:2 is adopted as opposed to -pkgsys-boot/grub:2/pkg. +pkg, therefore the notation +pkgsys-boot/grub/pkg:2 is adopted as opposed to +pkgsys-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 https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages;> -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:
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 427ba55ed4af436ebf2a4dc420c5db77f7f3430c Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:52:02 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:55 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=427ba55e ebuild-writing/misc-files/metadata: use conventional metadata.xml tag ordering Matches other examples on the page too. Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index eb6551c..416167c 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -479,11 +479,6 @@ as opposed to a URL. Conversely, email addresses specified in the ?xml version="1.0" encoding="UTF-8"? !DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata - upstream -bugs-tomailto:dev-port...@gentoo.org/bugs-to; - changeloghttps://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES/changelog; - dochttps://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage/doc; - /upstream maintainer type="person" emailla...@gentoo.org/email nameLarry the Cow/name @@ -502,6 +497,11 @@ as opposed to a URL. Conversely, email addresses specified in the installing files. Usually only required for hardened systems. /flag /use + upstream +bugs-tomailto:dev-port...@gentoo.org/bugs-to; + changeloghttps://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES/changelog; + dochttps://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage/doc; + /upstream /pkgmetadata
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: a93ddfdf28dd37d25e4967c8c97b5bc93be70d15
Author: Sam James gentoo org>
AuthorDate: Wed Jan 12 05:01:04 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Jan 12 06:28:56 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a93ddfdf
ebuild-writing/misc-files/metadata: minor phrasing tweak
Signed-off-by: Sam James gentoo.org>
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index a961821..2bc6100 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -633,8 +633,8 @@ specified in the subslots tag.
-Maintainer-needed, or orphaned, packages have no maintainers
-responsible for them. Per
+Maintainer-needed ("orphaned") packages have no maintainers responsible for
+them. Per
https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages;>
GLEP 67, these packages must not contain any maintainer
subtags under pkgmetadata in their metadata.xml. A strict
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: ee6c5a78e4eb2a2051f0ce6ef9856dd10c3f4b14 Author: Ulrich Müller gentoo org> AuthorDate: Sat Sep 11 10:44:55 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 11 14:09:23 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ee6c5a78 ebuild-writing/misc-files/metadata: Replace http by https Bug: https://bugs.gentoo.org/552720 Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 0fdf675..eb6551c 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -411,7 +411,7 @@ description. ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata maintainer type="project" emailoff...@gentoo.org/email @@ -477,7 +477,7 @@ as opposed to a URL. Conversely, email addresses specified in the ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata upstream bugs-tomailto:dev-port...@gentoo.org/bugs-to; @@ -536,7 +536,7 @@ is demonstrated. ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata maintainer restrict="gt;=sys-boot/grub-2" type="person" emailflop...@gentoo.org/email @@ -595,7 +595,7 @@ specified in the subslots tag. ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata maintainer type="project" emailbase-sys...@gentoo.org/email @@ -656,7 +656,7 @@ part of the QA reports. ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata !-- maintainer-needed -- upstream @@ -691,7 +691,7 @@ English and optionally in other languages). A typical example: ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE catmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; catmetadata longdescription lang="en" The app-vim category contains plugins and syntax file
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 99492cb137c6ec5bb324103413a7848f371790e2 Author: Ulrich Müller gentoo org> AuthorDate: Thu Apr 16 12:56:42 2020 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Apr 16 16:51:01 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=99492cb1 ebuild-writing/misc-files/metadata: Add example code for m-n detection. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 12 ++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index abc5a3e..6cf7609 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -636,8 +636,16 @@ Maintainer-needed, or orphaned, packages have no maintainers responsible for them. Per https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages;> GLEP 67, these packages must not contain any maintainer -subtags under pkgmetadata in their metadata.xml. By -convention, a comment line containing the string maintainer-needed +subtags under pkgmetadata in their metadata.xml. A strict test +for this condition would be: + + + +[[ $(xmllint --xpath "count(/pkgmetadata/maintainer)" metadata.xml) -eq 0 ]] + + + +By convention, a comment line containing the string maintainer-needed is inserted. Other tags which are relevant to the package may be present in the metadata. Bugs for these packages must be assigned to maintainer-nee...@gentoo.org. The QA team periodically generates the
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 026f710748d54e300f25d39dccbf20d15f84e98d Author: Ulrich Müller gentoo org> AuthorDate: Thu Apr 16 12:54:52 2020 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Apr 16 16:51:01 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=026f7107 ebuild-writing/misc-files/metadata: Describe stabilize-allarches. Information taken from metadata.dtd and GLEP 68. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 13 +++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index db082df..abc5a3e 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -67,6 +67,7 @@ metadata.xml: allowed: maintainer, longdescription, +stabilize-allarches, slots, use, and upstream. @@ -118,6 +119,14 @@ metadata.xml: two optional subtags: pkg and cat. + + stabilize-allarches + +Indicates an architecture-independent package. An ebuild can be marked +stable for all relevant architectures, when it has been tested on only one +architecture. This tag must have empty content. + + slots @@ -271,8 +280,8 @@ There are also some attributes that can be used with these tags: restrict -maintainer, -longdescription, flag +maintainer, longdescription, +stabilize-allarches, flag The restrict attribute allows one to restrict the application of
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: e2eb4339f8182dbc17959cf77f59e00afac5f949 Author: Ulrich Müller gentoo org> AuthorDate: Thu Apr 16 16:40:09 2020 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Apr 16 16:40:09 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e2eb4339 ebuild-writing/misc-files/metadata: Reorder tags. before seems to be the most common ordering, in the examples below and in the tree. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 22 +++--- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index c4aa7bc..db082df 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -65,8 +65,8 @@ metadata.xml: This is the root element of the metadata.xml file for packages. It has no attributes. The following subtags are allowed: -longdescription, maintainer, +longdescription, slots, use, and upstream. @@ -74,16 +74,6 @@ metadata.xml: appear at most once. - - longdescription - -This tag contains a description for a category or a package. For -packages, it is used to augment the - -DESCRIPTION field in the ebuilds themselves. This tag has -two optional subtags: pkg and cat. - - maintainer @@ -118,6 +108,16 @@ metadata.xml: It is optional. + + longdescription + +This tag contains a description for a category or a package. +For packages, it is used to augment the + +DESCRIPTION field in the ebuilds themselves. This tag has +two optional subtags: pkg and cat. + + slots
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 9426f87e1b36af1247d9a97dbbe6311b75f6326b Author: Ulrich Müller gentoo org> AuthorDate: Mon Jan 20 16:42:58 2020 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Jan 23 00:01:02 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9426f87e ebuild-writing/misc-files/metadata: Explain EAPI 0 atom. Since EAPIs 0 to 2 are no longer mentioned, we need to explain what an "EAPI=0 package dependency specification" is. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 7 --- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index d7f883a..7756665 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -280,9 +280,10 @@ There are also some attributes that can be used with these tags: is used, other tags with or without the restrict attribute must be present to cover all the versions of the package. A tag without the restrict attribute serves as the default. The format of the -restrict attribute is that of a EAPI=0 package dependency -specification. Due to the limitations of XML, the "" and -"" need to be specified using "lt;" and "gt;". +restrict attribute is that of a EAPI=0 package dependency specification +(i.e., USE-conditional or slot dependendencies are not allowed). +Since and are special characters in XML, +they must be escaped using lt; and gt;.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 7dfbf123c416148170b43bae3bf7634edf08b8f1 Author: Göktürk Yüksek gentoo org> AuthorDate: Thu Jan 9 00:57:04 2020 + Commit: Göktürk Yüksek gentoo org> CommitDate: Tue Jan 14 20:35:58 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7dfbf123 ebuild-writing/.../metadata: clarify that upstream maintainer takes no 'type' Closes: https://bugs.gentoo.org/703626 Closes: https://github.com/gentoo/devmanual/pull/140 Signed-off-by: Göktürk Yüksek gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 4d2d7cf..54b7bd2 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -174,6 +174,8 @@ metadata.xml: Provides information about the upstream maintainer. It requires a 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.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/, ebuild-maintenance/maintenance-tasks/, ...
commit: 688b7114682f9faf594d1aa740de1b6dd9c653ac Author: Ulrich Müller gentoo org> AuthorDate: Wed Dec 4 17:06:29 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 8 11:32:03 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=688b7114 Elements , , and are not supported. Use instead, which seems to be the most appropriate replacement in their respective contexts. Signed-off-by: Ulrich Müller 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. Package-Manager: This is automatically inserted by repoman commit and it specifies the version of -sys-apps/portage on the system. +sys-apps/portage on the system. RepoMan-Options: This is automatically inserted by repoman commit and records the options passed to repoman (such as --force) for the commit. 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. -You should never stabilize packages on -architectures for which you cannot test and instead you should file a bug to -the relevant architecture team, such as -sp...@gentoo.org 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 never stabilize packages on architectures for which you +cannot test and instead you should file a bug to the relevant architecture +team, such as sp...@gentoo.org asking them to stabilize the ebuild. +Alternatively, you may be able to find Gentoo developers on IRC who could help +you with your request. -It is best to not use -arch-maintain...@gentoo.org, adding architecture teams onto a -bug's CC list individually instead. That way teams can remove +It is best to not use arch-maintain...@gentoo.org, 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. 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: -catmetadata +catmetadata This is the root element of the metadata.xml file for categories. It has no attributes. It contains a number of -longdescription tags, each for a different -language. +longdescription tags, each for a different language. -pkgmetadata +pkgmetadata This is the root element of the metadata.xml file for packages. It has no attributes. The following subtags are allowed: -longdescription, -maintainer, -slots, -use, and -upstream. +longdescription, +maintainer, +slots, +use, and +upstream. While all the subtags are optional, upstream may appear at most once. - longdescription + longdescription This tag contains a description for a category or a package. For packages, it is used to augment the DESCRIPTION field in the ebuilds themselves. This tag has -two optional subtags: pkg and -cat. +two optional subtags: pkg and cat. -maintainer +maintainer This tag specifies the persons and/or projects responsible for the maintenance of a package. The type attribute must -be specified and can be either "person" or -"project". There is one required subtag: -email. It has two optional subtags: -name and -description. +be specified and can be either "person" or "project". +There is one required subtag: +email. It has two optional subtags: +name and +description. - email + email This contains the e-mail address of the maintainer. It is required. - name + name This contains freetext with the name of the maintainer. It is optional. - description + description 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 @@
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 36023f0c54f9974c6ce8f22d34276d725c536767 Author: Göktürk Yüksek gentoo org> AuthorDate: Thu Apr 13 15:52:30 2017 + Commit: Göktürk Yüksek gentoo org> CommitDate: Thu Apr 13 19:34:55 2017 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=36023f0c ebuild-writing/misc-files/metadata: repoman does not depend on libxml2 anymore When repoman was a part of sys-apps/portage, it didn't pull in libxml2 in the ebuild. The developers needed to make sure that libxml2 is installed on the system to perform metadata checks. Now that it's split into app-portage/repoman, it pulls in dev-python/lxml properly and this statement is no longer valid. ebuild-writing/misc-files/metadata/text.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index ad429a5..44a8554 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -360,9 +360,8 @@ using the app-portage/metagen tool. -Commits of package metadata files are handled by repoman. In -order for metadata checks to be performed, dev-libs/libxml2 -must be installed on the system. +Commits of package metadata files are handled by repoman as +part of regular package maintenance.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 49fb72be41dc38a280c3da6a259dd229b85baf59 Author: Wim Muskee gmail com> AuthorDate: Sat Dec 10 10:43:24 2016 + Commit: Göktürk Yüksek gentoo org> CommitDate: Sun Dec 11 05:59:48 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=49fb72be ebuild-writing/metadata: indentation rules, #591548 ebuild-writing/misc-files/metadata/text.xml | 15 +++ 1 file changed, 15 insertions(+) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index e6dd819..ad429a5 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -21,6 +21,21 @@ The character set must be UTF-8 as specified by +Concerning indentation there is no strict rule governing the style and +width. However the following minimal set of rules need to be followed: + + +Indentation should be consistent, i.e. either spaces or tabs, but +not both. + + +Keep the existing style when touching metadata.xml files that +belong to other developers. + + + + + The following table summarizes the tags that may appear in a metadata.xml:
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: d6d3b3a1ef7e1d10bec37cf438722d9784033eeb Author: Göktürk Yüksek gentoo org> AuthorDate: Wed May 18 05:25:22 2016 + Commit: Göktürk Yüksek binghamton edu> CommitDate: Wed May 18 05:30:20 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d6d3b3a1 ebuild-writing/misc-files: re-indent the category metadata.xml example Re-indent the category metadata.xml example so that it's more in line with the package metadata examples. Signed-off-by: Göktürk Yüksek gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 24 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index ffd2993..e6dd819 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -657,18 +657,18 @@ English and optionally in other languages). A typical example: -?xml version="1.0" encoding="UTF-8"? -!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; -catmetadata -longdescription lang="en" -The app-vim category contains plugins and syntax file -packages for the Vim text editor. -/longdescription -longdescription lang="de" -Die Kategorie app-vim enthält Plugins und Syntax-Pakete -für den Vim Texteditor. -/longdescription -/catmetadata +?xml version="1.0" encoding="UTF-8"? +!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +catmetadata + longdescription lang="en" +The app-vim category contains plugins and syntax file +packages for the Vim text editor. + /longdescription + longdescription lang="de" +Die Kategorie app-vim enthält Plugins und Syntax-Pakete +für den Vim Texteditor. + /longdescription +/catmetadata
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: ce5c5b320b1d69080c1ee9591c984ad1f28ee49c Author: Göktürk Yüksek binghamton edu> AuthorDate: Mon Feb 29 08:18:41 2016 + Commit: Göktürk Yüksek binghamton edu> CommitDate: Wed May 18 04:39:49 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ce5c5b32 ebuild-writing/misc-files/metadata: rewrite the section per GLEP 67 #572144 A major rewrite of the section. Here is a brief summary of changes: - Remove the information about the tag per GLEP 67 - Restructure the section in the following order: - metadata.xml syntax - package metadata - metadata examples - maintainer-needed - category metadata - Update the tables for metadata.xml syntax per GLEP 67 - Rewrite the package metadata examples to reflect better on GLEP 67 and enhance with more explanations - Assign meaningful titles to package metadata examples instead of using "First Example", "Second Example" etc. - Add a subsection for handling maintainer-needed in metadata.xml per GLEP 67 and provide an example This commit also makes #545272 obsolete. Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=572144 Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=545272 Signed-off-by: Göktürk Yüksek binghamton.edu> ebuild-writing/misc-files/metadata/text.xml | 418 1 file changed, 238 insertions(+), 180 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 2324f53..31ec926 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -10,16 +10,7 @@ package or category. -Package Metadata - - -For packages, metadata.xml can specify a long description and -maintainer information. If a long description in any language is -provided, an English long description must be present. A typical -example might look like: - - - +Syntax @@ -39,13 +30,10 @@ A metadata.xml file can contain a number of tags: This is the root element of the metadata.xml file for packages. It has no attributes. The following subtags are allowed: -herd, maintainer, longdescription, use, and upstream. -There should be at least one herd or -maintainer subtag. @@ -62,26 +50,16 @@ A metadata.xml file can contain a number of tags: -herd - - -If a package is maintained by one or more herds, names of these herds -can be specified with the herd tag. The names -used in this tag must be the same as specified in the https://sources.gentoo.org/viewcvs.py/*checkout*/gentoo/xml/htdocs/proj/en/metastructure/herds/herds.xml?content-type=text/plainrev=HEAD;>herds.xml -file. - - - - maintainer -Besides being part of a herd, a package can also be maintained directly. -The maintainers of a package can be specified with the -maintainer tag. This tag has one required subtag: +This tag specifies the persons and/or projects responsible for +the maintenance of a package. The type attribute must +be specified and can be either "person" or +"project". There is one required subtag: email. It has two optional subtags: -name, and description. +name and +description. @@ -207,8 +185,7 @@ A metadata.xml file can contain a number of tags: -There are also some attributes that can be used with these tags. They are all -optional: +There are also some attributes that can be used with these tags: @@ -235,7 +212,7 @@ optional: restrict -herd, maintainer, +maintainer, longdescription, flag @@ -244,12 +221,7 @@ optional: without this attribute must also exist. That tag without the restrict attribute will serve as the default. The format of the restrict attribute is that of the DEPEND flag, except that "" and -"" need to be specified by lt; and gt;. - -For example, in the sys-libs/db package, -restrict="gt;=sys-libs/db-3.2.9-r5" on the -maintainer tag shows that I'm currently maintaining all -versions greater then 3.2.9-r5. +"" need to be specified by "lt;" and "gt;". @@ -282,212 +254,298 @@ optional: remote-id -A string identifying the type of upstream source. A list of valid strings are kept in metadata.dtd. +A string identifying the type of upstream source. A list of valid strings are kept in +https://www.gentoo.org/dtd/metadata.dtd;>metadata.dtd. Developers should email the gentoo-dev mailing list before using a new type value. + + type + +maintainer + + +Defines the type of the maintainer for a package. There are only +two valid values: "person" and "project". The latter +denotes an official + +Gentoo project. + + - - - - -Metadata Examples - -First Example +Package Metadata - -In this first example we provide you with the metadata.xml for -OpenOffice of
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 1ed9fb686fd3b10ee9a0f7f4b797765073508113 Author: Göktürk Yüksek binghamton edu> AuthorDate: Thu Apr 28 07:53:34 2016 + Commit: Göktürk Yüksek binghamton edu> CommitDate: Wed May 18 04:39:49 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1ed9fb68 ebuild-writing/misc-files/metadata: add an example for slots and subslots Signed-off-by: Göktürk Yüksek binghamton.edu> ebuild-writing/misc-files/metadata/text.xml | 50 + 1 file changed, 50 insertions(+) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 3d135a6..486af11 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -549,6 +549,56 @@ is demonstrated. + +Slots and Subslots + + + +The main focus of this example is to demonstrate how slots and +subslots are specified, by examining the metadata of +media-libs/libpng. There may be multiple reasons for +slotting depending on the nature of the package. For this particular +package, it can be seen that the slots are used to provide different +versions of the library with varying binary compatibility and that +developers are advised to build against the slot 0. Furthermore, +different versions of this package with the same subslot provide the +same Application Binary Interface (ABI), according to the description +specified in the subslots tag. + + + +?xml version="1.0" encoding="UTF-8"? +!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; +pkgmetadata + maintainer type="project" +emailbase-sys...@gentoo.org/email +nameGentoo Base System/name + /maintainer + use +flag name="apng"support unofficial APNG (Animated PNG) spec/flag + /use + upstream +remote-id type="cpe"cpe:/a:libpng:libpng/remote-id +remote-id type="sourceforge"apng/remote-id + /upstream + slots +slot name="0" + For building against. This is the only slot + that provides headers and command line tools. +/slot +slot name="1.2" + For binary compatibility, provides libpng12.so.0 only. +/slot +slot name="1.5" + For binary compatibility, provides libpng15.so.15 only. +/slot +subslotsReflect ABI compatibility for libpng.so./subslots + /slots +/pkgmetadata + + + +
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: f00b95e90d87fc6ffd0fa0f2ba800c4c1799769e Author: Göktürk Yüksek gentoo org> AuthorDate: Wed May 18 05:20:39 2016 + Commit: Göktürk Yüksek binghamton edu> CommitDate: Wed May 18 05:20:39 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f00b95e9 ebuild-writing/misc-files: do not use https in DOCTYPE for metadata files libxml2 has no SSL support and therefore cannot fetch the DTD served over https. See the Gentoo commit: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=1bfb585cc60a9e This partially reverts 5b16122e6786de482bf8a57ae7eebcc8a31d4b17 Signed-off-by: Göktürk Yüksek gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 486af11..ffd2993 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -658,7 +658,7 @@ English and optionally in other languages). A typical example: ?xml version="1.0" encoding="UTF-8"? -!DOCTYPE catmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; +!DOCTYPE catmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"; catmetadata longdescription lang="en" The app-vim category contains plugins and syntax file
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: a61f033e215514521966959a47913e8c91a6fce8 Author: Göktürk Yüksek binghamton edu> AuthorDate: Wed Apr 27 06:57:25 2016 + Commit: Göktürk Yüksek binghamton edu> CommitDate: Wed May 18 04:39:49 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a61f033e ebuild-writing/misc-files/metadata: update wrt slotting and per GLEP 68 Add information about specifying slots and subslots in the metadata. Also, update the section according to the specifications in GLEP 68, clarify some of the tags better, and reorder the tags to improve the flow of the text. Signed-off-by: Göktürk Yüksek binghamton.edu> ebuild-writing/misc-files/metadata/text.xml | 140 ++-- 1 file changed, 93 insertions(+), 47 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 31ec926..3d135a6 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -14,7 +14,15 @@ package or category. -A metadata.xml file can contain a number of tags: +A metadata file follows the syntax defined in +https://wiki.gentoo.org/wiki/GLEP:68;>GLEP 68. +The character set must be UTF-8 as specified by +https://wiki.gentoo.org/wiki/GLEP:31;>GLEP 31. + + + +The following table summarizes the tags that may appear in a +metadata.xml: @@ -24,28 +32,41 @@ A metadata.xml file can contain a number of tags: +catmetadata + + +This is the root element of the metadata.xml file for +categories. It has no attributes. It contains a number of +longdescription tags, each for a different +language. + + + + pkgmetadata This is the root element of the metadata.xml file for packages. It has no attributes. The following subtags are allowed: -maintainer, longdescription, +maintainer, +slots, use, and upstream. +While all the subtags are optional, upstream may +appear at most once. + longdescription -catmetadata - - -This is the root element of the metadata.xml file for -categories as per https://wiki.gentoo.org/wiki/GLEP:34;>GLEP 34. -It has no attributes. It contains a number of -longdescription tags, each for a different -language. +This tag contains a description for a category or a package. For +packages, it is used to augment the + +DESCRIPTION field in the ebuilds themselves. This tag has +two optional subtags: pkg and +cat. @@ -83,11 +104,25 @@ A metadata.xml file can contain a number of tags: - longdescription + slots + +This tag describes the +slots of a package. +It has two optional subtags: slot and subslots. + + + + slot + +This contains information for a particular slot. The name +attribute is mandatory and specifies the name of the slot. + + + + subslots -This tag contains a description of the package. This is to augment the -DESCRIPTION field in the ebuilds themselves. This tag has two optional -subtags: pkg and cat. +Describes the meaning of subslots for the whole package. This +tag may appear at most once. @@ -113,25 +148,30 @@ A metadata.xml file can contain a number of tags: upstream This tag contains information about the upstream developers/project. +It supports multiple optional subtags: maintainer, +changelog, doc, bugs-to, +and remote-id. maintainer -Name and e-mail of an upstream maintainer. May appear more than once. +Provides information about the upstream maintainer. It requires a +name subtag to be specified, supports an optional +email subtag and an optional status attribute. - email + name -The email address of an upstream may appear only once and must appear in first place. +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. - name + email -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 only once. +The email address of an upstream maintainer. May appear only once. @@ -141,7 +181,7 @@ A metadata.xml file can contain a number of tags: The URL must be version independent and must point to a changelog which is only updated on new releases of the corresponding package. (This also implies that one can link to an automatically updated changelog in case of vcs snapshots -only.) +only). May appear at most once. @@ -151,14 +191,14 @@ A metadata.xml file can contain a number of tags: found. The link must not point to any third party documentation and must be version independent. If the documentation is available in more than
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 4688fe60725dcf52e5cd8c4e9574f0f200dbabc8 Author: Ulrich Müller gentoo org> AuthorDate: Fri Feb 5 12:50:41 2016 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Feb 5 12:58:22 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4688fe60 ebuild-writing/misc-files/metadata: Don't mention glep31check. This tool isn't (and never was) in the tree and the sources seem to be unavailable. Therefore the documentation should not recommend its use. Bug: 572156 ebuild-writing/misc-files/metadata/text.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 2de3cf5..2324f53 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -531,7 +531,6 @@ is currently: xmllint --noout --valid metadata.xml -glep31check metadata.xml git add metadata.xml git commit --gpg-sign
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 3e930ac8b66435a57c5375351e58d61e4491a6b2 Author: Gokturk Yuksek binghamton edu> AuthorDate: Thu Feb 4 00:57:33 2016 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Feb 5 12:58:19 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3e930ac8 ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Replace "cvs commit" with the equivalent "git add && git commit" version. Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642 Signed-off-by: Gokturk Yuksek binghamton.edu> ebuild-writing/misc-files/metadata/text.xml | 16 +++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index e506b1c..2de3cf5 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -532,7 +532,21 @@ is currently: xmllint --noout --valid metadata.xml glep31check metadata.xml -cvs commit -m "Adding category metadata.xml for my-category" metadata.xml +git add metadata.xml +git commit --gpg-sign + + + +The commit message should be formatted properly. +A sample commit is shown below: + + + +commit db359439bcd52f5a7f20d2332ab62feb16657504 +Author: Alexis Ballier aball...@gentoo.org +Date: Tue Sep 22 10:47:49 2015 +0200 + + dev-ros: Add metadata.xml for the category.
