aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* g-c/dependencies: Clarify the stance on circular dependenciesHEADmasterAndrei Horodniceanu12 days1-0/+8
| | | | | | | | | | | | | I had a package that needed changes that would introduce a dependency cycle with USE=test and I had to ask on IRC whether this was OK. Sam told me not to worry about it and recommended that the devmanual should note this. So, add a paragraph that discourages dependency cycles but expresses that cycles provoked by USE=test can usually be ignored. Signed-off-by: Andrei Horodniceanu <a.horodniceanu@proton.me> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/error-handling: Refer to PIPESTATUS, not its valueUlrich Müller13 days1-7/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/error-handling: Fix exampleUlrich Müller13 days1-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/messages: Change ewarn to eqawarn in the example codeSebastian Engel2024-09-141-6/+6
| | | | | | | | | The message in the code block is clearly a message from an eclass author to ebuild developers and therefore should use eqawarn and not ewarn, like the "QA warnings" passage above describes. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* archs/x86: Remove some outdated team guidelinesSebastian Engel2024-09-141-6/+0
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* src_unpack/rpm-sources: Replace src_unpack override example codeSebastian Engel2024-09-141-4/+2
| | | | | | | | | This replaces the code example with a snippet of how it is currently used in ::gentoo/dev-util/intel-ocl-sdk/intel-ocl-sdk-18.1.0.015.ebuild because the old example code had multiple issues. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* g-c/portage-cache: Refine the allowed variables for conditional inheritsSebastian Engel2024-09-141-1/+2
| | | | | | | | Since the code example after the text uses PV to show allowed conditional inherits, the preceding text should also mention that PV is valid. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/messages: Remove history lessonSebastian Engel2024-08-311-3/+2
| | | | | | | | | The mentioned versions are over 18 years old and the elog functionality has become common. There is no value in stating when it was implemented. Removed Paludis because it has no relevance for Gentoo. (unlike maybe for PMS) Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Remove bash version historySebastian Engel2024-08-311-2/+1
| | | | | | | | Those bash "here strings" were introduced 22 years ago and stating the version they were implemented does not serve any purpose any more. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Format the word variable as inline codeSebastian Engel2024-08-231-1/+1
| | | | | | | | | The devmanual commonly uses <c> to format variables in text passages as code to make them more distinguishable from the rest of the text and that's why it should be done here too. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/grep: Remove the phonetic spelling of the -l parameterSebastian Engel2024-08-231-3/+2
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* g-c/dependencies + f-r/query-functions: Remove double if constraintsSebastian Engel2024-08-232-2/+2
| | | | | | | | | The double if "if and only if" feels bumpy when reading, makes the reader wonder if there is a deeper hidden meaning but serves no purpose, so remove it. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/echo: Improve wording in abuse chapterSebastian Engel2024-08-231-6/+6
| | | | | | | | "should be used as less as possible" is not a correct expression, use "should be avoided" instead. Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix multiple typos and grammatical errorsSebastian Engel2024-08-126-15/+15
| | | | | Signed-off-by: Sebastian Engel <sighunter@gmx.de> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Use self-closing tags when possibleUlrich Müller2024-07-301-22/+22
| | | | | | | This makes no difference for the HMTL output, i.e. xsltproc will expand <foo/> to <foo></foo>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/copyright-policy: Exceptions are granted by the CouncilUlrich Müller2024-07-251-1/+1
| | | | | | | See GLEP 76 update: https://gitweb.gentoo.org/data/glep.git/commit/?id=7f0ce454b2359ed742b84d1d60176fadad15c066 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Delete P0 from list of custom variablesUlrich Müller2024-07-241-1/+1
| | | | | | As discussed in #gentoo-qa. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Add todo items for EAPIs 5 and 6Ulrich Müller2024-07-051-0/+14
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing, function-reference: Update eqawarn documentationUlrich Müller2024-07-052-5/+6
| | | | | | No longer mention eutils.eclass for eqawarn. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* function-reference/version-functions: New chapterUlrich Müller2024-07-054-17/+229
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices/contributors: WhitespaceUlrich Müller2024-06-111-4/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices/contributors: DTD has been replaced by RELAX NG schemaUlrich Müller2024-06-111-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Check if /guide/@self agrees with the document pathUlrich Müller2024-06-111-0/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Rename parameter of repeat-string templateUlrich Müller2024-06-101-6/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "general-concepts/tree: Allow @ in filenames"Ulrich Müller2024-06-021-1/+1
| | | | | | | | | | | As it turns out, Portage will silently drop files containing an @ char during Manifest generation. See bug 411127 and bug 106544 for further reference. This reverts commit 38de9c654dd036b304b158a32b14dbe785327938. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/tree: Allow @ in filenamesUlrich Müller2024-06-021-1/+1
| | | | | | As discussed in #gentoo-dev. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/removal: Use the new PKGREMOVED resolutionMichał Górny2024-05-081-1/+1
| | | | Signed-off-by: Michał Górny <mgorny@gentoo.org>
* devbook.xsl: Use abbreviated CC-BY-SA-4.0 in footerUlrich Müller2024-05-071-1/+1
| | | | | | This agrees with the footer in other gentoo.org sites. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Document that sentence case should be used in titlesUlrich Müller2024-05-071-0/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* More sentence case changesUlrich Müller2024-05-077-13/+13
| | | | | | Apparently these have been missed previously. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal referencesUlrich Müller2024-05-0737-71/+75
| | | | | | | Internal links referring to sections were broken by the previous "Sentence case devmanual" commit. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: Revert wording changeUlrich Müller2024-05-071-1/+1
| | | | | | | | This is referred to as the "Clean patch howto" from several other places. The wording change would also break links because the section title is used as fragment identifier. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Sentence case devmanualMatthew Marchese2024-05-07113-348/+349
| | | | | | 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>
* ebuild-writing/functions/src_prepare/eapply: fix typoLouis Sautier2024-04-291-1/+1
| | | | | Signed-off-by: Louis Sautier <sbraz@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/licenses: Licenses must be plain textUlrich Müller2024-04-291-5/+5
| | | | | | | Historically we had some PDF files in the repository, but the last of them was removed in 2011. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* No longer mention PORTDIRUlrich Müller2024-04-294-12/+11
| | | | | Closes: https://bugs.gentoo.org/865455 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Some updates from patch reviewUlrich Müller2024-04-241-4/+4
| | | | | | Suggested by mjo and sam. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Formatting fixesUlrich Müller2024-04-241-4/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Add @DEAD tag to tableUlrich Müller2024-04-241-0/+9
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "eclass-writing: @DEAD must be the first tag"Ulrich Müller2024-04-241-3/+1
| | | | | | | | eclass-to-manpages is now less strict about placement of the tag. This reverts commit cd392d0c6cd064ac3a1381111e678f4fe111afcc. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_prepare/eapply: Clarify eapply for dirUlrich Müller2024-04-231-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* .gitignore: Ignore Emacs backup filesUlrich Müller2024-04-221-0/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* lang.highlight.ebuild.xsl: Drop epatch keywordUlrich Müller2024-04-221-2/+0
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_prepare/eapply: Rework the chapterUlrich Müller2024-04-221-127/+76
| | | | | | | Drop explanation of epatch. Rework the eapply sections and add additional examples. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_prepare: Rename epatch chapter to eapplyUlrich Müller2024-04-215-5/+5
| | | | | | Update references throughout. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tools-reference/diff-and-patch: No longer mention epatchUlrich Müller2024-04-211-2/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/git: drop repoman from commit messageVolkmar W. Pogatzki2024-04-131-6/+0
| | | | | Signed-off-by: Volkmar W. Pogatzki <gentoo@pogatzki.net> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Add Gentoo e.V. to page footerUlrich Müller2024-03-231-1/+1
| | | | | Bug: https://bugs.gentoo.org/927555 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/file-format: Update year in ebuild headerUlrich Müller2024-02-211-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* package-moves: Allow moving back, and describe how to chain updatesMichał Górny2024-02-081-2/+48
| | | | | | | | | | | | | | | | | Make the rule forbidding reusing old package names less strict. There is no real reason not to move packages back — we can safely assume that the package manager will handle that just fine. The only real restriction is that no other package must reuse any of the old names, i.e. effectively cause the package manager to attempt merging the packages together. Add explicit rules for updating old package move entries. These match the logic used in pkgcheck, and therefore ensure both correct results and no warnings from pkgcheck. Signed-off-by: Michał Górny <mgorny@gentoo.org> [Replace Unicode subscripts by <sub> markup] Signed-off-by: Ulrich Müller <ulm@gentoo.org>