summaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
* Cheat sheet: Expand acronym in abstractHEADmasterUlrich Müller9 days1-6/+3
| | | | | | Delete commented-out text. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: Document *.z suffix in unpackUlrich Müller2024-09-101-3/+4
| | | | | | | | | | | Portage has accepted the lowercase *.z and *.tar.z suffixes for gzip-compressed files since version 2.0.24 in 2002: https://gitweb.gentoo.org/archive/proj/portage-cvs.git/commit/?id=322d745eff81a5e647b70c3d55bee5dd17e08296 This won't make any difference for newer EAPIs (where unpack's suffix matching is case-insensitive). Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: Clarify "skipped silently" in unpackUlrich Müller2024-09-091-2/+2
| | | | | | | | | | | | | The previous wording was added in commit 634c32f with the EAPI 3 (later to become EAPI 4) draft. The commit message doesn't give any rationale for "silently". It may well be that the wording is a remnant of the rejected "unpack --if-compressed" feature. See also the discussion in the 2009-04-23 council meeting: https://projects.gentoo.org/council/meeting-logs/20090423.txt (starting at 21:35). Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* dependencies.tex: Clarify specification of the slot= operatorUlrich Müller2024-07-071-7/+8
| | | | | Reported-by: Jannik Glückert <jannik.glueckert@gmail.com> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Explicitly list LaTeX source filesUlrich Müller2024-06-161-1/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.cls: Use sans serif font for title and headingsUlrich Müller2024-06-111-3/+17
| | | | | | | | | | | | | | This tries to update the printed version to have a more modern look. It is somewhat inspired by the KOMA-Script classes, e.g. scrreprt.cls, which also use sans-serif fonts for their headings. Slightly reduce the size of chapter headings (again, inspired by KOMA-Script, with the headings=normal package option). Note that the Helvetica font specified by helvet.sty was never used, see also the commit message of commit 9d68105. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.cls: Slightly decrease textheightUlrich Müller2024-05-282-4/+6
| | | | | | | | | Also make it a multiple of 12pt (= \baselineskip). Automatically calculate the width of the last column in the big variables table. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "pms.cls: Require version 1 of parskip.sty"Ulrich Müller2024-05-281-1/+1
| | | | | | This reverts commit 4ebd8cb10bcf73fba3bbf06e9aa8370fcf692538. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.cls: Redefine headings for list of tables etc.Ulrich Müller2024-05-131-1/+8
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.cls, eapi-cheatsheet.tex: Avoid conditional code in \dateUlrich Müller2024-05-132-12/+10
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use sentence case throughoutUlrich Müller2024-05-0821-70/+70
| | | | | | | | | | | | Subsection headings were already changed from title case to sentence case in commit ca463ce. This left chapter and section headings alone, which is inconsistent (although it is specified by some style guides like APA). This commit changes headings to sentence case throughout, following most other Gentoo documentation, e.g. wiki and devmanual. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Be more specific about REPLACING_VERSIONS phasesUlrich Müller2024-04-021-3/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-vars.tex: Add "test_privileged" to valid "PROPERTIES"Michał Górny2024-03-031-0/+2
| | | | | | | | | | | Add "test_privileged" to the values of "PROPERTIES", as introduced in Portage commit 997058a825a340813532bef77a34425cf4a88eb2 (to be included in 3.0.62). This is akin to "test_network", used to indicate that the test suite needs superuser privileges. Bug: https://bugs.gentoo.org/924585 Signed-off-by: Michał Górny <mgorny@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: EBUILD_PHASE{,_FUNC} are valid only in phasesUlrich Müller2024-02-221-7/+7
| | | | | | | | | | | | Portage didn't ever set (or unset) these variables to a special value when sourcing the ebuild, so obviously ebuilds cannot rely on this. Restrict their validity to actual phases and make global scope behaviour unspecified. The previous wording was introduced with commit 58d3bc0. Bug: https://bugs.gentoo.org/908552 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tree-layout.tex: Plural use of "data" is preferred in BEUlrich Müller2024-02-221-1/+1
| | | | | | | | https://digitalblog.ons.gov.uk/2016/12/08/data-is-versus-data-are/ This also fixes an "underfull \hbox" error. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* tree-layout.tex: Loosen restrictions on reusing package and slot namesUlrich Müller2024-01-271-3/+3
| | | | | Closes: https://bugs.gentoo.org/923019 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.tex: Update copyright yearsUlrich Müller2024-01-271-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Clarify that D is not valid in pkg_postinstUlrich Müller2023-12-291-5/+4
| | | | | | | | | | | | | | | | | | | | D in pkg_* phases was first mentioned in SVN r74 (commit f627e46102c6) as a variable specific to the pkg_preinst phase function (replacing IMAGE). pkg_postinst was added in r88 (commit 3da3ee561f1a), but this was reverted in r89 (commit 65c466317718) "D in pkg_postinst == bad". pkg_postinst reappeared when the env vars section was converted to a table in commit 58d3bc0e8301. According to chapter 13 "Merging and Unmerging", the method used to perform the merge is not specified, and merging a regular file or a directory may alter or remove its source under D. Therefore, trying to access any file in D during the postinst phase is an error. The scope of ED follows that of D. Closes: https://bugs.gentoo.org/920889 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: Sandbox commands accept any fileUlrich Müller2023-12-241-6/+6
| | | | | | | | | | | | | The sandbox commands addread, addwrite, addpredict and adddeny can accept not only directories, but also other files like regular files or device nodes. This behaviour is supported by all three package managers. Also, the sandbox's default configuration relies on it (e.g. "/dev/null" and "${HOME}/.bash_history" in /etc/sandbox.conf), and it is widely used in the Gentoo repository. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Variables may not be meaningful in global scopeUlrich Müller2023-08-071-2/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Add footnote about BROOT in pkg_* phasesUlrich Müller2023-08-071-1/+2
| | | | | | | Restrict the previous change to EAPIs that actually support IDEPEND. Bug: https://bugs.gentoo.org/911574 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: BROOT is valid in additional pkg_* phasesUlrich Müller2023-08-061-1/+2
| | | | | | | | | | | | | By section sec:dependency-classes, dependency class BDEPEND is satisfied in phase functions src_* and pkg_setup (only if part of source build); IDEPEND is satisfied in pkg_preinst, pkg_postinst, pkg_prerm and pkg_postrm. Update the entry for BROOT accordingly. Closes: https://bugs.gentoo.org/911574 Reported-by: Mike Gilbert <floppym@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Avoid "Ditto" in the env variables tableUlrich Müller2023-08-061-12/+11
| | | | | Suggested-by: Sam James <sam@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Reformat the footnotes in the env variables longtableUlrich Müller2023-08-062-4/+11
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* metadata-cache.tex: Document the md5-dict cache formatUlrich Müller2023-06-042-6/+41
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.bib: Use @techreport entry type for GLEPsUlrich Müller2023-05-293-14/+29
| | | | | | | This is a slightly better fit than @manual. Also, change citation keys to lowercase. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: Drop CONF_LIBDIR* and DEFAULT_ABIUlrich Müller2023-05-041-26/+4
| | | | | | | | | | | | | | | | | | | The CONF_LIBDIR variable was used exclusively in the 2004.3 profile (i.e. it was no longer defined in 2005.0). Portage support for CONF_LIBDIR was added by this commit: https://gitweb.gentoo.org/archive/proj/portage-cvs.git/commit/?id=ecc2faaa00b1e6250129267ba873bedd2121eac5 Note that neither the ABI nor the LIBDIR_${ABI} variable existed at the time. The CONF_LIBDIR_OVERRIDE and DEFAULT_ABI variables were never implemented in the dolib* and einstall commands in Portage. With the three variables dropped, the algorithm is identical to the logic used for get_libdir(). Therefore drop alg:ebuild-libdir and refer to alg:get-libdir instead. Bug: https://bugs.gentoo.org/267159 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* EAPI feature table: Don't use a landscape tableUlrich Müller2023-04-142-237/+81
| | | | | | | Drop EAPIs 0 to 4 from the table, as well as items that would have identical entries for all listed EAPIs. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* profiles.tex: The parent file can contain commentsUlrich Müller2023-04-141-1/+2
| | | | | Closes: https://bugs.gentoo.org/470094 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Appendix: Document retroactive econf changeUlrich Müller2023-04-101-0/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: econf matches configure --help output betterUlrich Müller2023-02-271-2/+5
| | | | | | | | | | | Following the previous change for --disable-static (commit e0aa80c), check for proper end of string for all option names beginning with "with", "disable" or "enable". This will mainly affect --with-sysroot, where false positives have been observed. Bug: https://bugs.gentoo.org/815169 Suggested-by: David Seifert <soap@gentoo.org> Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Reference sections by "section 11.2" rather than "11.2"Ulrich Müller2023-02-012-7/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: Fix indentation of listUlrich Müller2023-02-011-7/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* names.tex: Reorder subsectionsUlrich Müller2023-01-291-5/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Distinguish between "phase" and "phase function"Ulrich Müller2023-01-182-4/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* names.tex: Specify eclass namesUlrich Müller2023-01-182-0/+6
| | | | | | | | | | | | | | | | | | | Eclasses may export phase functions prefixed with their name, so ideally we would follow the syntax of Bash (and POSIX) identifiers: | A word consisting solely of underscores, digits, and alphabetics | from the portable character set. The first character of a name is | not a digit. Because many existing eclasses have a dot or a hyphen in their name, we follow usage in the Gentoo repository instead. (The only historical exception to the above was 64-bit.eclass, not used since 2006 and removed in 2009.) An eclass must not be named "default", otherwise names of exported functions would collide with default_<phase-function>. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* WhitespaceUlrich Müller2023-01-186-15/+16
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.tex: Update copyright yearsUlrich Müller2023-01-091-1/+1
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* ebuild-env-vars.tex: D is available as a variable in all src_* phasesUlrich Müller2023-01-091-6/+9
| | | | | | | | | | | | | | | | The D variable has been described as a "phase-specific variable" since the spec's early draft stage (SVN r19). However, Portage would always define the variable in all src_* phases, with the restriction that the directory would exist only in src_install(). In reality, not all ebuilds comply with the spec. For example, Perl eclasses use D in src_configure(), i.e. they rely on Portage behaviour. Therefore, lift this unnecessary and somewhat artificial restriction and make the variable (but not the directory) available outside the install phase. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Makefile: Use guessable names for section references in HTML outputUlrich Müller2022-12-271-0/+5
| | | | | | | | This replaces the "x1*" fragment identifiers by more predictable ones with a "chapter", "section", or "appendix" prefix. This is possible because our section numbers are unique. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "Appendix: Do not number sections."Ulrich Müller2022-12-271-1/+0
| | | | | | This reverts commit 1da137e49aa5a52bb13500192d394b6dd53210da. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Revert "Appendix: Include EAPI differences sections in table of contents."Ulrich Müller2022-12-271-9/+9
| | | | | | This reverts commit fbcb58732d0a75138c0c7185f914d10f448ed472. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Use "app:" instead of "ch:" for labels in the appendixUlrich Müller2022-12-273-5/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices.tex: Mention EAPI for econf --disable-staticUlrich Müller2022-12-111-3/+5
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Don't use teletype for EAPIsUlrich Müller2022-12-092-7/+7
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* appendices.tex: No line break before GLEP numberUlrich Müller2022-12-091-3/+3
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pms.bib: Update GLEP references to latest Post-History dateUlrich Müller2022-11-251-4/+4
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* glossary.tex: Drop chapter numberUlrich Müller2022-11-253-5/+6
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* Appendix: Document retroactive change of econf --disable-staticUlrich Müller2022-11-192-0/+9
| | | | Signed-off-by: Ulrich Müller <ulm@gentoo.org>
* pkg-mgr-commands.tex: Update condition for econf --disable-static (again)Ulrich Müller2022-11-191-2/+3
| | | | | | | | | | | | | | | | | The intention is to pass --disable-static, in order to (only) disable static libtool archive building. The current condition asks for either of --{disable,enable}-static in configure --help output, which causes false positives: https://archives.gentoo.org/gentoo-portage-dev/message/efc3f424d1dffd3415da538ec25532a9 Therefore, narrow the condition to require both --enable-static and --enable-shared. In addition, backport the check for proper end of string from the EAPI 9 feature list, but restrict it to this option for now. Bug: https://bugs.gentoo.org/814368 Bug: https://bugs.gentoo.org/815169 Signed-off-by: Ulrich Müller <ulm@gentoo.org>