aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* ebuild-writing/misc-files/metadata: minor phrasing tweakSam James6 days1-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 James6 days1-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 James6 days1-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>
* ebuild-writing/user-submitted: unified diffs are preferredSam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/user-submitted: mention git commit --authorSam James2021-04-071-1/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: slight phrasing tweak re patch sourceSam James2021-04-071-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/misc-files/patches: grammatical fix re patch strip levelSam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/pkg_postrm: add explicit xdg-utils inherit to exampleSam James2021-04-071-0/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/pkg_postinst: use ${variable} style in exampleSam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_compile/no-build-system: sync example with ::gentooSam James2021-04-071-4/+4
| | | | | | | We preserve the simplicity of the example though. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_configure: copy flag-o-matic notice from ↵Sam James2021-04-071-0/+7
| | | | | | | src_compile Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_configure: add explicit flag-o-matic inherit to ↵Sam James2021-04-071-0/+2
| | | | | | | | | | example We seem to sometimes include inherits, and sometimes not, and I think it's useful to include these to aid familiarity for newcomers. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_configure: drop whitespace in $(use_enable)Sam James2021-04-071-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/use-conditional-code: use eapply, not epatchSam James2021-04-071-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/pkg_nofetch: sync default impl with portageSam James2021-04-071-5/+5
| | | | | | | See https://github.com/gentoo/portage/blob/master/bin/phase-helpers.sh#L743. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/messages: add missing || die in src_compile exampleSam James2021-04-071-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: Fix Gentoo Bugzilla URLUlrich Müller2021-03-301-2/+2
| | | | | | | Warning on previous git push: remote: WARNING: invalid Gentoo Bugzilla URL: https://bugs.gentoo.org/show_bug.cgi?id=werror Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: modernise autotools/econf advice on verbose logSam James2021-03-301-3/+4
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: adjust XML style for build systems listSam James2021-03-301-15/+20
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/common-mistakes: slight grammar fixes/phrasing changesSam James2021-03-301-8/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>