aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Rename the document element from "guide" to "devbook"Ulrich Müller2024-11-091-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>
* general-concepts/ebuild-revisions: Almost always revbump when stableUlrich Müller2024-10-291-12/+12
| | | | | | | Drop the paragraph after the example and make it a new list item with updated wording. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: mention balancing examples against stableSam James2024-10-291-0/+5
| | | | | | | | | | | | | Explicitly say that even 'no revision bump' examples should be balanced against whether a stable ebuild is being modified, as we want to minimize any risk of regressions there. i.e. It might be that a change would not need a revbump for an ~arch-only ebuild, but if the ebuild is stable, the principle of being conservative ofr stable would mean a revbump is warranted. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix internal referencesUlrich Müller2024-05-071-2/+2
| | | | | | | 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-1/+1
| | | | | | 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>
* Fix internal linksUlrich Müller2023-10-301-4/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: License updates may require a revbumpUlrich Müller2023-08-261-0/+4
| | | | | | | See for example bug 912458, where removal of the unused CMake license caused a blocker on users' systems. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: clarify interaction with adding/removing ↵Sam James2023-01-141-2/+8
| | | | | | | | | | | | | | | | USE flags Note that when adding a USE flag where the functionality was previously on (not off in build system), one must revbump because a dep was unconditional that now became conditional. Also, if removing a USE flag where the behaviour is now on, but was previously always off (not on in build system), one must revbump also, because people might have never set USE=foo (hence --changed-use wouldn't pick it up) but their deps have now effectively changed. Bug: https://github.com/pkgcore/pkgcheck/pull/435 Signed-off-by: Sam James <sam@gentoo.org>
* general-concepts/ebuild-revisions: note that build failures may be a missing ↵Sam James2022-11-101-2/+3
| | | | | | | | | | | rdepend If, for example, a "qtcore" missing dependency results in a src_configure failure and a bug is filed, that doesn't mean a revbump can be skipped, as for others, if they had qtcore installed already, the package is silently linked against it without it being recorded as a dependency. Signed-off-by: Sam James <sam@gentoo.org>
* general-concepts/ebuild-revisions: note which build-time fixes need a new ↵Sam James2022-11-101-1/+5
| | | | | | revision Signed-off-by: Sam James <sam@gentoo.org>
* ebuild-maintenance/removal: Change inconsistent virtual revbump policySam James2022-10-141-5/+0
| | | | | | | | | | | | | | | | This partly reverts commit f28b85f069c70538c618a3cedece77a359601dd8. There's no reason to treat virtuals differently here, there's no exception for it in how Portage works, and it may cause upgrade difficulties for users. It's also led to extensive confusion with contributors & new developers as we have to try to explain the inconsistency between devmanual and policy for non-virtuals. See: https://github.com/gentoo/gentoo/pull/27637 Closes: https://github.com/gentoo/devmanual/pull/303 Signed-off-by: Sam James <sam@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>
* Remove references to repomanMatt Turner2022-03-141-3/+2
| | | | | | Bug: https://bugs.gentoo.org/835013 Closes: https://github.com/gentoo/devmanual/pull/274 Signed-off-by: Matt Turner <mattst88@gentoo.org>
* general-concepts/ebuild-revisions: Fix link syntaxUlrich Müller2021-09-241-2/+2
| | | | | Fixes: 22a7fb2ca3bc0897a80b27470da1f9b5f06dd874 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: mention pkgdev as alternativeJoonas Niilola2021-09-241-2/+3
| | | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/248
* general-concepts/ebuild-revisions: mention EAPI bumpJoonas Niilola2021-09-241-1/+5
| | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* general-concepts/ebuild-revisions: clarify the automagic dep detectionJoonas Niilola2021-09-241-4/+1
| | | | | | | | - the current example is very hard to realize what it means, I'm only guessing it means automagic dep detection? Let's update it to make it clearer? Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* general-concepts/ebuild-revisions: mention removing a virtual pkgJoonas Niilola2021-09-241-1/+6
| | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* general-concepts/ebuild-revisions: add 'updating USE flag defaults' in dep ↵Sam James2021-07-031-0/+1
| | | | | | | | | | | | | as revbump reason Without revision bumping in cases where we change USE dep defaults in a dependency, the package manager will refuse an upgrade because newer versions of the dependency will not satisfy the requirements in the package. Closes: https://github.com/gentoo/devmanual/pull/232 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: add 'subscribing with :=' as revbump reasonSam James2021-07-031-0/+1
| | | | | | | | | | A revision bump is needed for a rebuild to occur when e.g. ABI is broken. Without doing this, we're relying on Portage's preserve-libs feature which does not have to be enabled and is not specified by PMS. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/ebuild-revisions: Provide examples for when to revbump or notMichał Górny2017-09-251-7/+44
| | | | Provide a wider set of examples when to revbump or not.
* general-concepts/ebuild-revisions: Provide a 3-step guide for when to revbumpMichał Górny2017-09-251-17/+32
|
* general-concepts/ebuild-revisions: Clearly define the purpose of revisionsMichał Górny2017-09-251-0/+14
|
* general-concepts/ebuild-revisions: by default -> when empty (more precise)Michał Górny2017-09-251-2/+3
|
* Merge remarks about revision bumps from Developer Handbook.Ulrich Müller2015-05-031-0/+4
| | | | | | | | | This is taken from proj/en/devrel/handbook/hb-policy-ebuild.xml, section "Ebuild policy", subsection "Versioning and revision bumps". Permission to reuse the CC-BY-SA-1.0 work under CC-BY-SA-2.0 (or any later version) obtained from author plasmaroo per e-mail on 2015-04-16.
* Make it clear that modifying stable ebuilds should be avoided.Pawel Hajdan jr2010-03-141-0/+6
|
* Slight wording fix.Mark Loeser2008-04-031-1/+1
| | | | git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@120 176d3534-300d-0410-8db8-84e73ed771c3
* Add some more uri'sMark Loeser2006-03-091-1/+1
| | | | git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@18 176d3534-300d-0410-8db8-84e73ed771c3
* Add uri's where we can right nowMark Loeser2006-03-051-1/+2
| | | | git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@14 176d3534-300d-0410-8db8-84e73ed771c3
* Change -- to <d/> where appropriate. Finish up the autotools docMark Loeser2006-02-271-2/+2
| | | | git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@11 176d3534-300d-0410-8db8-84e73ed771c3
* Add some more pages. The Makefile now generates the png's at build time, so ↵Mark Loeser2006-02-271-0/+35
we don't need the PNGs in the repo anymore git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@7 176d3534-300d-0410-8db8-84e73ed771c3