Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
path: root/ebuild-writing
Commit message (Collapse)AuthorAgeFilesLines
* ebuild-writing/eapi: Replace interactive by live in exampleUlrich Müller2022-10-191-2/+2
| | | | | | The former is semi-deprecated and we shouldn't advertise its use. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Explicitly specify UTF-8 encoding in XML declarationsUlrich Müller2022-10-0940-40/+40
| | | | | | As specified by the DevBook XML guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: Fix example for ROOTUlrich Müller2022-08-251-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: Add section about reserved variablesUlrich Müller2022-08-181-0/+35
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: Demote single variable sections to subsectionsUlrich Müller2022-08-171-170/+170
| | | | | | Reorder subsections to follow the ordering of the tables. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: Update restrict attributeUlrich Müller2022-05-271-9/+6
| | | | | | | | | | | | | | 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 <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: Language tags can be BCP 47Ulrich Müller2022-05-271-3/+3
| | | | | | | This corresponds to the update of GLEP 68. Bug: https://bugs.gentoo.org/578294 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/patches: Add "Conditional patching" sectionThomas Bracht Laumann Jespersen2022-04-061-0/+59
| | | | | | | | | | | | | The added section under "Patches" tries to describe what patches are intended for and why conditional patching should be avoided. It was pointed out in a PR review that conditional patching in general should be avoided as it introduces more variance and can make it harder to debug breakage if a patch is only applied under certain conditions (USE flags being the primary example). Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/user-submitted: Add cross-reference to copyright policyUlrich Müller2022-03-301-0/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Remove references to repomanMatt Turner2022-03-143-6/+6
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* ebuild-writing/eapi: update link to Python guideSam James2022-02-251-1/+1
| | | | | | Migrated to projects.gentoo.org. Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/eapi: mention blocker retention periodSam James2022-02-221-0/+9
| | | | | | | Bug: https://bugs.gentoo.org/821553 Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/261 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/eapi: document upgrade path policySam James2022-02-221-0/+21
| | | | | | | | | | | | | | | The "upgrade path" policy is not particularly well-defined; over the years, various people have come to understand it as "two years", "one year", with mixed interpretations within that (is it enough to be able to upgrade just Portage?) This is a start towards formalising policy here, even if we end up changing it later, at least it's codified. Closes: https://bugs.gentoo.org/821553 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/variables: link to package/slot move page in SLOTSam James2022-02-181-1/+2
| | | | | Closes: https://bugs.gentoo.org/388685 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/variables: WhitespaceUlrich Müller2022-02-161-1/+0
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: Selectively lifting SRC_URI restrictionsMatthew Smith2022-02-161-1/+61
| | | | | Closes: https://github.com/gentoo/devmanual/pull/271 Signed-off-by: Matthew Smith <matthew@gentoo.org>
* ebuild-writing/common-mistakes: .diff -> .patchSam James2022-01-221-1/+1
| | | | | | We usually use .patch nowadays so reflect that in the docs. Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/misc-files/metadata: minor phrasing tweakSam James2022-01-121-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: fix formatting, use <c> tags consistentlySam James2022-01-121-20/+21
| | | | | | Signed-off-by: Sam James <sam@gentoo.org> [Whitespace changes] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: use conventional metadata.xml tag orderingSam James2022-01-121-5/+5
| | | | | | | Matches other examples on the page too. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: add calling external tools without dieSam James2021-12-221-0/+13
| | | | | | | Suggested-by: Joonas Niilola <juippis@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> [Internal cross reference fixed] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack/rpm-sources: use EAPI 8 in exampleSam James2021-12-091-7/+6
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/users-and-groups: Sync with QA policyUlrich Müller2021-11-161-6/+6
| | | | | | UIDs and GIDs can be chosen from the range 101..749. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: fix formatting of DESCRIPTION/HOMEPAGE noteSam James2021-09-171-0/+2
| | | | | | Reported-by: Ulrich Müller <ulm@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/metadata: Replace http by httpsUlrich Müller2021-09-111-6/+6
| | | | | Bug: https://bugs.gentoo.org/552720 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_unpack: Update list of unpack formatsUlrich Müller2021-08-281-3/+0
| | | | | | | | | | Drop 7zip, RAR, and LHA from the list of recognized unpack formats, following the EAPI 8 change to unpack(). This considers that these formats were never widely used, and that soon most new ebuilds will use the new EAPI. Closes: https://bugs.gentoo.org/810796 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Rewrap a long lineUlrich Müller2021-08-141-5/+5
| | | | | Fixes: 947a4714250dfb5d614bce6ef3689b655f235234 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/file-format: rewrap long paragraphSam James2021-08-141-5/+6
| | | | | | Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/242 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/file-format: link to PMS for version specificationSam James2021-08-141-0/+8
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/functions/src_compile/building: don't call CC directlySam James2021-08-141-0/+9
| | | | | | | | Bug: https://bugs.gentoo.org/243502 Bug: https://bugs.gentoo.org/726034 Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/243 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/functions/src_test: Clarify how localhost can be usedMichał Górny2021-08-011-2/+10
| | | | | | | Closes: https://github.com/gentoo/devmanual/pull/227 Signed-off-by: Michał Górny <mgorny@gentoo.org> [Reword as suggested by Sam James and Florian Schmaus] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: rewrap paragraphSam James2021-08-011-3/+4
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: reformat 'DESCRIPTION and HOMEPAGE'Sam James2021-08-011-4/+5
| | | | | Closes: https://github.com/gentoo/devmanual/pull/223 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: add 'Calling pkg-config directly'Sam James2021-08-011-1/+22
| | | | | | | | Quite a lot of ebuilds do this. We should instead use the tc-getPKG_CONFIG helper from toolchain-funcs.eclass which respects ${PKG_CONFIG} - useful for e.g. cross-compiling. Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention leftover USE flags, inheritsSam James2021-08-011-0/+13
| | | | | Suggested-by: Joonas Niilola <juippis@gentoo.org> (inherits) Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention HTTPS for HOMEPAGESam James2021-08-011-1/+2
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/common-mistakes: mention using latest EAPISam James2021-08-011-0/+14
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/functions/src_compile/building: minor phrasing fixSam James2021-08-011-2/+2
| | | | Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/eapi: Add EAPI 8 guideUlrich Müller2021-07-121-0/+766
| | | | | | | | | | | | Main part taken from "The ultimate guide to EAPI 8" by Michał Górny: https://mgorny.pl/articles/the-ultimate-guide-to-eapi-8.html Converted to DevBook XML and heavily edited to make it fit into the framework of the devmanual. Original-Author: Michał Górny <mgorny@gentoo.org> Original-License: CC-BY-3.0 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_test: explicitly say USE=test is for only some ↵Sam James2021-07-061-0/+8
| | | | | | | | | | | | | cases It's only needed where we have test dependencies, we want to conditionally build tests, conditionally fetch files, or otherwise alter behaviour based on the fact we're running tests (e.g. usage in RESTRICT). Closes: https://github.com/gentoo/devmanual/pull/231 Suggested-by: Florian Schmaus <flow@gentoo.org> Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: discourage adding comments within patchSam James2021-06-181-0/+8
| | | | | | | | | | We shouldn't add comments (#) within patch changes to source code (etc) because it's unnecessary noise. Comments *at the top* of the patch are, of course, welcoome. Closes: https://github.com/gentoo/devmanual/pull/217 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: modernise patch exampleSam James2021-06-181-2/+2
| | | | | | | | * Drop dates as we now recommend * Use patch level 1 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions: mention defining phases in the canonical orderSam James2021-06-181-0/+5
| | | | | | | | This aids readability. Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/224 Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-writing/functions/src_compile/building: Pass CPPFLAGS to emakeUlrich Müller2021-06-151-1/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_compile/building: add ${CPPFLAGS} to cc invocationSam James2021-06-151-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/variables: PROPERTIES may also contain 'live' and 'test_network'Florian Schmaus2021-05-281-1/+1
| | | | | Signed-off-by: Florian Schmaus <flo@geekplace.eu> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_configure/configuring: drop whitespace in ↵Sam James2021-04-101-8/+8
| | | | | | | | $(use_enable) Closes: https://github.com/gentoo/devmanual/pull/221 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/user-submitted: mention checking for Signed-off-bySam James2021-04-071-0/+5
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: add reference to ${FILESDIR} in other sectionSam James2021-04-071-1/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/use-conditional-code: use || die in exampleSam James2021-04-071-1/+1
| | | | | | | | | For the purposes of the example, it's best to keep using || die. Plus, in this situation, it's likely we'd want to know if the big files were renamed or similar. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>