Get Gentoo!
gentoo.org sites
gentoo.org Wiki Bugs Forums Packages
Planet Archives Sources
Infra Status
aboutsummaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Makefile: Test for emake instead of EBUILD_PHASEHEADmasterUlrich Müller2025-01-061-1/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* eclass-writing: Specify @BLURB more preciselyUlrich Müller2025-01-051-8/+9
| | | | | | | | | | | | | | The @BLURB description appears in the NAME section of the generated man page, and should therefore follow the rules from man-pages(7): "All words in this line (including the word immediately following the '\-') should be in lowercase, except where English or technical terminological convention dictates otherwise." Since it is a section heading, it should not end with a full stop either. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Update copyright yearsUlrich Müller2025-01-052-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* general-concepts/use-flags: hint towards CMAKE_DISABLE_FIND_PACKAGE_<pkg>Florian Schmaus2024-12-091-3/+4
| | | | | Signed-off-by: Florian Schmaus <flow@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Add internal links to eclass documentationUlrich Müller2024-12-0715-52/+59
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-maintenance/git: Fix a typoUlrich Müller2024-12-071-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Do not break lines within opening XML tagsUlrich Müller2024-12-079-30/+33
| | | | | | As mandated by the DevBook XML guide. No text changes. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Refer to the Package Manager Specification by its full nameUlrich Müller2024-11-126-26/+26
| | | | | | | Other small updates of wording (when in the same paragraph). Fix/update some external links. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Rework the contents templateUlrich Müller2024-11-091-80/+75
| | | | | | | | | - New extraction-count template, split off from contents - Fix path_rel; it was correct only for the two special cases of an empty path or a path equal to @self - Suppress empty <ul></ul> in output Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Rename "contentsTree" element to "contents"Ulrich Müller2024-11-0924-34/+34
| | | | | | For consistency; this was the only element using camelCase. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Rename the document element from "guide" to "devbook"Ulrich Müller2024-11-09139-315/+316
| | | | | | | | | 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>
* devbook.xsl: Test for include instead of contentsTree in dropdown menuUlrich Müller2024-11-091-2/+2
| | | | | | | This is cleaner and coincides with what is done in the contentsTree template itself. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Fix dropdown menu in appendices/todo-listUlrich Müller2024-11-061-2/+2
| | | | | | | The contentsTree element must be skipped when it comes with an extraction attribute. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices/editor-configuration/xemacs: Update for XEmacs 21.5Ulrich Müller2024-11-051-7/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Secondary expansion is not neededUlrich Müller2024-11-031-8/+3
| | | | | | | | | | | | | | Drop .SECONDEXPANSION and use a static pattern rule instead. The problem addressed by secondary expansion was that % in a "normal" pattern rule doesn't match the empty string, therefore %index.html won't match the top-level index.html target. By contract, % in a static pattern rule matches any part of the target name. Using a pattern rule like "ind%x.html: t%xt.xml ..." would also be possible but seems a little hackish. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Suppress permalinks in offline modeUlrich Müller2024-11-011-2/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Remove the separate "build" targetUlrich Müller2024-11-011-8/+9
| | | | | | | | | | | | This had been added in commit aa6e1e365fff48b6e1e5470791f499a0589d39c3, so that app-doc/devmanual[offline] could call "emake build" without building documents.js. This is no longer needed; the offline condition can be tested by the Makefile itself. Drop validate as prerequisite of all because it required libxml2 as additional build dependency. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Don't warn about missing eclass doc when in ebuild contextUlrich Müller2024-10-311-4/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: More specific prerequisites for install targetUlrich Müller2024-10-311-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Restore commented-out captions of code samplesUlrich Müller2024-10-311-9/+10
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Support caption attribute for pre, codesample and tableUlrich Müller2024-10-314-3/+35
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Delete redundant xsl:textUlrich Müller2024-10-301-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Drop obsolete commentUlrich Müller2024-10-301-2/+0
| | | | 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>
* bin/gen-eclass-html.sh: Use intra-document link targetsUlrich Müller2024-10-291-1/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Update message for eclasses fallbackUlrich Müller2024-10-291-13/+18
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* bin/gen-eclass-html.sh: Add local variables block for EmacsUlrich Müller2024-10-291-0/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* xsl: Drop the xmlns=xhtml attribute from all stylesheet elementsUlrich Müller2024-10-288-52/+56
| | | | | | | | | | | | | | | | | | | | This caused some HTML elements to contain spurious xmlns attributes, e.g. in quickstart/index.html: <span xmlns="http://www.w3.org/1999/xhtml" class="Statement">dodoc</span> Apparently this is valid in HTML 5, so neither tidy nor the W3C validator would warn about it (and it went unnoticed since 2015): "In HTML documents, elements in the HTML namespace may have an xmlns attribute specified, if, and only if, it has the exact value 'http://www.w3.org/1999/xhtml'." https://html.spec.whatwg.org/multipage/dom.html#global-attributes Use single and double quotes consistently. Whitespace fixes. Fixes: bf60a8772d3ece409e2fbe0b4dd8b5a5dd7df167 Fixes: e918c7dc8268c4a4723ab4b3a35479f4d191a765 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook.xsl: Rework templates for previous/next nodeUlrich Müller2024-10-271-89/+62
| | | | | | | | | | - Separate finding the node from HTML formatting. - Determine the absolute parent path from the path of our own @self attribute, rather than from the parent document's @self attribute. - Get the first node from the following-sibling or preceding-sibling axis directly, instead of laboriously calculating its index. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Add distclean targetUlrich Müller2024-10-271-2/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/functions/src_prepare/eapply: Fix linkUlrich Müller2024-10-271-1/+1
| | | | | Fixes: b599e3ba8a93655663ff6dae76d6117a8a455d66 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* devbook-guide: Clarify use of the term "tag"Ulrich Müller2024-10-241-3/+3
| | | | | | | - The XML declaration is not a tag. - A tag cannot be closed; an element can (by a closing tag). Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* .github/workflows/devmanual-ci.yml: Update to actions/checkout@v4Ulrich Müller2024-10-241-2/+2
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* g-c/dependencies: Clarify the stance on circular dependenciesAndrei Horodniceanu2024-09-281-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üller2024-09-281-7/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-writing/error-handling: Fix exampleUlrich Müller2024-09-281-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>