aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* 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-18/+18
| | | | | | 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-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: use <c> tag for dev-util/ebuildtesterPetr Vaněk2023-09-271-1/+1
| | | | | Signed-off-by: Petr Vaněk <arkamar@atlas.cz> 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>
* general-concepts/dependencies: add paragraph explaining exampleFlorian Schmaus2022-06-241-0/+32
| | | | | | | | | | | Add a small paragraph explaining the existing slot-operator example. This is scavenged from my proposed change for bug #739858. Signed-off-by: Florian Schmaus <flow@gentoo.org> Bug: https://bugs.gentoo.org/739858 [Commits squashed; small fixes according to style guide.] Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: WhitespaceUlrich Müller2022-05-271-2/+2
| | | | | | Fixes: d08d5f0dea3d8580c55a052d6424863d6aeb8ae9 Fixes: 6c0b51ae63833c2ddfd58412727c0004db06d605 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: expand on finding correct deps a bitJoonas Niilola2022-05-221-3/+11
| | | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/284
* general-concepts/dependencies: add new section for indirect depsJoonas Niilola2022-05-221-0/+17
| | | | Signed-off-by: Joonas Niilola <juippis@gentoo.org>
* general-concepts/dependencies: improve explaination of slot operatorsFlorian Schmaus2022-02-211-8/+9
| | | | | | | | | | | | | | | | | | The section previously had hard to parse sentences like "[…] and that your package should be rebuilt if the version best matching the runtime dependency is updated to a version with a different slot or subslot" for the := operator. This commit attempts to improve the readability of the section. The change superseeds my proposed change in bug #739858. Thanks to Sam James for reviewing this. :) Signed-off-by: Florian Schmaus <flow@gentoo.org> Bug: https://bugs.gentoo.org/739858 Closes: https://github.com/gentoo/devmanual/pull/259 Signed-off-by: Sam James <sam@gentoo.org>
* general-concepts/dependencies: indent xml for better raw readabilityFlorian Schmaus2022-02-211-13/+23
| | | | | | | | This is scavenged from my proposed change for bug #739858. Signed-off-by: Florian Schmaus <flow@gentoo.org> Bug: https://bugs.gentoo.org/739858 Signed-off-by: Sam James <sam@gentoo.org>
* dependencies: clarify cross-compiling and system shorthandsMike Frysinger2021-10-191-5/+12
| | | | | | | | Try and clarify that BDEPEND/DEPEND are split based on the install targets, not only when the literal $CBUILD & $CHOST values differ, and thus only when "cross-compiling" is used. Signed-off-by: Mike Frysinger <vapier@gentoo.org>
* general-concepts/dependencies: clarify strong blocker usageSam James2021-10-131-0/+6
| | | | | | | | | | | | Noticed we could be a bit clearer in the devmanual after a discussion on a PR [0]. We've had a lot of confusion over when it's appropriate to use strong blockers, so I think giving a non-abstract "example" is helpful here. [0] https://github.com/gentoo/gentoo/pull/22433#discussion_r720746670 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: list any-of dependencies in preferred orderSam James2021-03-291-0/+6
| | | | | | | This eases Portage dependency resolution. Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: emphasise BDEPEND for build-system dependenciesSam James2021-03-291-2/+3
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: slightly modernise Qt exampleSam James2021-03-291-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* */*: consistent 'Portage' casingSam James2021-03-211-1/+1
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: add reference to Ebuild RevisionsSam James2021-03-111-0/+6
| | | | | | | | | Let's make a note that it's especially important to consider the links between dependencies and ebuild revisions. Closes: https://github.com/gentoo/devmanual/pull/197 Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: sort dependencies in exampleSam James2021-03-111-2/+2
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: add sortingSam James2021-03-111-0/+8
| | | | | Signed-off-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Tips for checking dependencies.Ulrich Müller2020-05-091-0/+51
| | | | | | | | | | | | | | | | | This is taken from the Gentoo Developer Handbook, chapter "Ebuild HOWTO" (proj/en/devrel/handbook/hb-guide-ebuild.xml), section "Package Dependencies", subsection "Important Notes", which in turn had been copied from chapter "Common ebuild Mistakes" (proj/en/devrel/handbook/hb-guide-common-mistakes.xml), section "Common Ebuild Writing Mistakes", subsection "DEPEND is incomplete". Permission to reuse the CC-BY-SA-1.0 work under CC BY-SA version 2.0 or any later version of that license obtained from author plasmaroo per e-mail on 2015-04-16, Message-ID <CAGV+WHCJ61hvw7kh+Wz=uO2esihwc1dXsCWJJWeFAA7UOyyayw@mail.gmail.com>. Closes: https://bugs.gentoo.org/465764 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Better section structure.Ulrich Müller2020-05-091-54/+60
| | | | | | Collect similar topics as subsections under new section headers. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Replace ">" by "&gt;" throughout.Ulrich Müller2020-02-181-7/+7
| | | | | | | Most instances are already being escaped, so convert the few remaining ones for consistency throughout the document. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=4 information to other sections.Ulrich Müller2020-02-111-5/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Utilities die, nonfatal: New section in ebuild-writing/error-handling, new chapter function-reference/error-functions - dodoc -r: Already in function-reference/install-functions, add additional example to ebuild-writing/functions/src_install - doins symlink support: Incorporated into function-reference/install-functions - dosed, dohard banned: Not mentioned anywhere else - econf --disable-dependency-tracking: New section about econf options in ebuild-writing/functions/src_configure/configuring - Controllable compression and docompress: New chapter ebuild-writing/functions/src_install/docompress - USE dependency defaults: Incorporated into general-concepts/dependencies - pkg_pretend: Already in ebuild-writing/functions/pkg_pretend - default src_install: Already in ebuild-writing/functions/src_install - pkg_info: Incorporated into ebuild-writing/functions/pkg_info - REQUIRED_USE: Already in ebuild-writing/variables - MERGE_TYPE, REPLACING_VERSIONS, REPLACED_BY_VERSION: Moved to ebuild-writing/variables - DOCS: Incorporated into ebuild-writing/variables - AA, KV removed: Not mentioned anywhere else - RDEPEND=DEPEND: Already handled in commit 5a946b4 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Describe circular deps in detailMichał Górny2020-01-291-0/+49
| | | | | Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Improve PDEPENDMichał Górny2020-01-291-7/+5
| | | | | | | | | | | Rewrite the PDEPEND description to be more focused on its purpose. Rename to 'Post Dependencies' to match PMS. Reverse the weird backwards logic that indicated that they might be installed before the package into saying that they may be installed after it. Clearly indicate that its only purpose is to resolve circular dependencies. Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Document BDEPENDMichał Górny2020-01-291-2/+46
| | | | | Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=3 information to other sections.Ulrich Müller2020-01-231-4/+1
| | | | | | | | | - Prefix support: Reference to Prefix documentation moved to ebuild-writing/variables - unpack .xz support: Add list of recognized unpack formats in ebuild-writing/functions/src_unpack Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=2 information to other sections.Ulrich Müller2020-01-231-15/+25
| | | | | | | | | | | | | | | | - doman language support: incorporated into function-reference/install-functions - Blockers incorporated into general-concepts/dependencies (also say "weak" and "strong" blockers instead of "soft" and "hard", in order to agree with the terms used in PMS) - USE dependencies: already in general-concepts/dependencies - SRC_URI arrows: incorporated into ebuild-writing/variables - src_prepare: already in ebuild-writing/functions/src_prepare - src_configure: already in ebuild-writing/functions/src_configure - Execution order: already in ebuild-writing/functions - Default phase functions moved to ebuild-writing/functions Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Drop section on if-else USE blocks.Ulrich Müller2020-01-231-30/+0
| | | | | | | If-else USE blocks, i.e. "Legacy Inverse USE-Conditional Dependency Syntax", have been abandoned before EAPI was introduced. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/eapi: Move EAPI=1 information to other sections.Ulrich Müller2020-01-231-5/+0
| | | | | | | | - Default src_compile: already in ebuild-writing/functions/src_compile - SLOT dependencies: already in general-concepts/dependencies - IUSE defaults moved to general-concepts/use-flags 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>
* general-concepts/dependencies: remove incorrect indentation in <p>Göktürk Yüksek2019-12-211-2/+2
| | | | | Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix nesting of elements.Ulrich Müller2019-12-081-2/+0
| | | | | | | | - Lists inside <p> are not allowed. - <ul> is not a direct child of <ul>; it must be inside <li>. - <p>, <note>, etc. are no children of <p>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Fix <body> elements.Ulrich Müller2019-12-081-10/+5
| | | | | | | No sectioning elements are allowed inside <body>, according to the devbook guide. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/dependencies: Fix ranged dependencies exampleThomas Deutschmann2019-10-161-1/+1
| | | | | | | Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/106 Acked-by: Michael Orlitzky <mjo@gentoo.org> Signed-off-by: Thomas Deutschmann <whissi@whissi.de> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
* Add section about defining "Test Dependencies"Mike Gilbert2018-09-101-0/+38
| | | | Reviewed-by: Ulrich Müller <ulm@gentoo.org>
* Replace the references to 'system' with '@system'Göktürk Yüksek2018-04-211-7/+10
| | | | | | Adopt the set notation using the '@' sign when refering to the system set. Also, system is not a target but a set. Therefore replace any references that refers to @system as 'target' with 'set'.
* Change the indentation for ebuild <codesample/> snippets from spaces to tabsGöktürk Yüksek2018-01-031-22/+22
|
* general-concepts/dependencies: Add a warning on pure DEPEND soft blockersMichał Górny2017-09-251-7/+13
|
* general-concepts/dependencies: Explain the meaning of hard blockers in DEP/RDEPMichał Górny2017-09-251-0/+9
|
* general-concepts/dependencies: Improve the description of blockersMichał Górny2017-09-251-8/+23
| | | | | | Improve the text describing blockers to clearly explain the difference between soft and hard blockers, and how are they supposed to be used. Emphasize on using in RDEPEND.
* Change "atom" to "package dependency specification" throughout.Ulrich Müller2016-12-291-4/+4
| | | | Bug: 603970
* Portage is the package manager. The repository is named gentoo.Alice Ferrazzi2016-11-191-1/+1
| | | | Changed Portage Tree with Gentoo Repository.
* Consistent EAPI declarationJohannes Huber2015-08-171-4/+4
| | | | | Most of occurrence of the EAPI declarations are without the quotes, so align the rest for more consistency.
* Clarify that PDEPEND may be installed after the package in some cases.Ulrich Müller2014-11-151-4/+6
| | | | Bug 424117.
* Document use dependency defaults on this section of the devmanualAnthony Ryan2014-10-181-3/+16
|
* add info to slot deps wrt #407597hasufell2013-07-291-0/+9
|
* add info about hardblockers wrt #407597hasufell2013-07-291-2/+14
|
* eapi: Improve sub-slot and slot operator documentation, bug #446740Alexandre Rostovtsev2013-01-191-0/+39
| | | | | | | | | | Add sub-slots to the Slotting chapter. Update the slot name sections to match current portage versions (as noted by Arfrever). Add slot operators to the Dependencies chapter, and describe sub-slot dependencies (as suggested by Arfrever). Rephrase the slot operator documentation in the EAPI Usage chapter to be a bit more readable and a bit less PMS-like, explain sub-slot dependencies in more detail, and add brief examples.