aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Rename the document element from "guide" to "devbook"Ulrich Müller12 days1-2/+2
| | | | | | | | | The "guide" document element is ambiguous with the previously used GuideXML format. Now that DevBook XML has a schema, this confuses Emacs nXML mode (which uses the document element to locate a schema), e.g. when visiting old GuideXML documentation files. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal referencesUlrich Müller2024-05-071-1/+1
| | | | | | | Internal links referring to sections were broken by the previous "Sentence case devmanual" commit. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sentence case devmanualMatthew Marchese2024-05-071-6/+6
| | | | | | Signed-off-by: Matthew Marchese <maffblaster@gentoo.org> [Whitespace. Fix rebase artifact in ebuild-writing/functions/src_test.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Explicitly specify UTF-8 encoding in XML declarationsUlrich Müller2022-10-091-1/+1
| | | | | | As specified by the DevBook XML guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: describe pending stabilization requestsSam James2022-03-161-0/+30
| | | | | | | Describe how maintainers should keep track of (and know when to file) pending stabilization requests. Signed-off-by: Sam James <sam@gentoo.org>
* keywording: Update arch status and stabilization notesMatt Turner2022-03-141-9/+4
| | | | | Closes: https://github.com/gentoo/devmanual/pull/275 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* Remove references to repomanMatt Turner2022-03-141-11/+1
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* keywording: it's preferred to rekeyword packages with new depsSam James2022-03-101-0/+10
| | | | | | | | | | | | | | | It's preferred to rekeyword packages with their new dependencies in the same bug rather than using `package.use.mask` as this means the new code path(s) using the new dependencies get tested rather than just the new package/dependency in isolation. Also, no tooling exists for arch testers to automatically remove the relevant mask(s) once keywording is done, so often we end up with stale unnecessary masks remaining in tree. Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/270 Signed-off-by: Sam James <sam@gentoo.org>
* keywording: note that stabilization rules are for actual testingSam James2022-02-181-0/+5
| | | | | | | | | | | | These rules are for maintainers wishing to stable if they have access to hardware -- they do _not_ mean maintainers must follow these rules just to file a bug and stabilise a package via CCing arch teams (the usual route). Closes: https://bugs.gentoo.org/546942 Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/267 Signed-off-by: Sam James <sam@gentoo.org>
* keywording: mention filing bugs for package.mask entriesSam James2022-01-221-0/+6
| | | | | | | | | | | | | | | It's useful to have a bug filed for things masked for testing / due to breakages so that feedback can be gathered in one place / the relevant issue can be debugged. We've sometimes had things p.masked indefinitely for "testing" when it's not clear exactly what needs to be done left, or due to a "bug" which with few details cannot be reproduced some time later. Bug: https://bugs.gentoo.org/705394 Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/262 Signed-off-by: Sam James <sam@gentoo.org>
* keywording: add note about `repoman commit --straight-to-stable`Sam James2022-01-221-1/+4
| | | | | | | | | | Somewhat regularly see --force being used with repoman commit rather than --straigh-to-stable. --straight-to-stable is preferable if it must be done because it doesn't disable repoman's other QA checks. Signed-off-by: Sam James <sam@gentoo.org>
* keywording: add explanatory text on maintainer obligationsSam James2022-01-221-0/+23
| | | | | | | Inspired partly by a discussion on a GitHub pull request [0]. [0] https://github.com/gentoo/gentoo/pull/23735 Signed-off-by: Sam James <sam@gentoo.org>
* keywording: add ekeyword ~all command exampleJoonas Niilola2021-10-131-3/+5
| | | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: wrap text at 80 charsJoonas Niilola2021-10-131-35/+36
| | | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: remove mentioning of STABLEREQ bugs.g.o keywordsFlorian Schmaus2021-07-161-2/+2
| | | | | | | | | This keyword is no longer used, NATTkA does not need it, and is redundant to the "Stabilization Request" component of the "Gentoo Linux" product, under which stabilization requests are filled. Signed-off-by: Florian Schmaus <flow@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: mention un-CCing arches if making substantial changes to listSam James2021-07-031-0/+6
| | | | | | Closes: https://github.com/gentoo/devmanual/pull/218 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: s/archs/arches/Sam James2021-04-071-10/+10
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: add QA policy link for dropped keywordsSam James2021-04-071-2/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: add arm/arm64 policy for keywording/stablizationSam James2021-04-071-0/+10
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: convert 'Stabilization rules' into a listSam James2021-04-071-18/+22
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: expound on NATTkA importance and HOWTOSam James2021-04-071-0/+35
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: add nuance about first-time ALLARCHES stabilisationsSam James2021-04-071-0/+7
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: note that setting KEYWORDS="" in a live ebuild is unnecessarySam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: non-developers should not add non amd64/x86 keywords in generalSam James2021-04-071-1/+4
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: make clear automatically CCing arches is preferredSam James2021-04-071-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: minor grammar/phrasing changesSam James2021-04-071-23/+23
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: call ~arch ("testing") and arch ("stable")Sam James2021-04-071-13/+14
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: mention pkgdev as an alternative to repomanSam James2021-03-301-3/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: use <stabilize-allarches/> as a real exampleJoonas Niilola2021-03-111-1/+1
| | | | | | | | | | - Make it clear and copy-pasteable that this tag has no content inside. Rest occurences in metadata/text.xml are descriptive text, not straight examples. Closes: https://github.com/gentoo/devmanual/pull/199 Signed-off-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* */*: Use modern example of a prefix arch/keywordSam James2021-02-171-1/+1
| | | | | | | | | | | Gentoo/OpenBSD and Gentoo/FreeBSD are gone, but we still have Prefix which has some arches like ~x64-macos, so let's use that to keep the same level of variety. Closes: https://github.com/gentoo/devmanual/pull/190 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Encourage setting ALLARCHES metadata tagSam James2021-02-171-0/+6
| | | | | | Closes: https://github.com/gentoo/devmanual/pull/188 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Use "Pure Python" instead of "Pure Perl"Sam James2021-02-171-1/+1
| | | | | | | | | | | | | | | We prefer not to use ALLARCHES for Perl packages because of how sensitive Perl can be to the underlying host. While Perl is cross-platform, use of functions which vary across hosts (e.g. unpack) is quite common. Let's use Python as an example instead which is endorsed [0] by Gentoo's Python Project. [0] https://wiki.gentoo.org/wiki/Project:Python#ALLARCHES Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Note that we can test x86 via amd64Sam James2021-02-171-1/+4
| | | | | | | Closes: https://github.com/gentoo/devmanual/pull/187 Suggested-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Clarify self-testing on amd64/x86Sam James2021-02-171-4/+3
| | | | | | | | | | | | | Some confusion occurred about whether this was just for keywording or not, so I've changed the phrasing. I've also removed the requirement for a bug; this isn't required in practice and adds unnecessary overhead. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Fix coding styleUlrich Müller2021-02-151-19/+19
| | | | | Fixes: 9c2e6f500a276b974bc2e2bd476d8423f113dbb2 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Mention NATTkAAlexey Sokolov2020-07-121-3/+7
| | | | | Signed-off-by: Alexey Sokolov <sokolov@google.com> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: SuperH is gone.Ulrich Müller2020-05-021-6/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack/vcs-sources: New file.Ulrich Müller2020-02-221-1/+1
| | | | | | | cvs-sources and svn-sources contain duplicate information, and it also applies to other VCSs. Combine them in a single chapter. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Add developer stabilization exception for AMD64/X86 arches.Tom Wijsman2020-01-251-0/+7
| | | | | | | | | | | References: - "AMD64 keywording" thread by kingtaco on the gentoo-core mailing list (2007) - app-emacs stabilization talk by kingtaco and ulm on IRC #gentoo-dev (2007) - Gentoo Council agenda item: "amd64 arch team and big bug list" (2008/03/13) Closes: https://bugs.gentoo.org/510198 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Include sections about stabilization.Ulrich Müller2020-01-251-14/+69
| | | | | | | | | Remove the ebuild-maintenance/stabilization section (which resulted from the split of ebuild-maintenance/maintenance-tasks), and include it in keywording. Delete duplicate and outdated information. Closes: https://bugs.gentoo.org/648316 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: Follow the terminology defined at start of the section.Ulrich Müller2020-01-231-10/+11
| | | | | Closes: https://bugs.gentoo.org/567312 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Suppress spurious newlines for <d/>.Ulrich Müller2020-01-181-2/+2
| | | | | | Also normalise whitespace around <d/> in some places in the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update redirected links.Ulrich Müller2020-01-101-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove newlines from section titles.Ulrich Müller2020-01-021-3/+1
| | | | | | These will get embedded into anchors, making them invalid. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove all p elements below dd.Ulrich Müller2019-12-261-8/+0
| | | | | | Where necessary, use multiple dd elements instead. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-081-4/+2
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* keywording: sort keywords outMikle Kolyada2018-08-271-4/+4
| | | | Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/91
* Update links to GLEPs.Ulrich Müller2017-10-131-2/+2
| | | | | | GLEPs have been moved to https://www.gentoo.org/glep/. Bug: https://bugs.gentoo.org/634198
* Gentoo is doing https for everythin nowJustin Lecher2015-08-211-1/+1
| | | | Signed-off-by: Justin Lecher <jlec@gentoo.org>
* Live ebuilds need not specify KEYWORDS.Ulrich Müller2015-06-011-1/+7
| | | | Bug 545488.