[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_unpack/rpm-sources/
commit: a166928ab188ff3b108d9a2651217dd96828b282
Author: Sebastian Engel gmx de>
AuthorDate: Wed Aug 28 11:13:20 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sat Sep 14 19:10:58 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a166928a
src_unpack/rpm-sources: Replace src_unpack override example code
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 gmx.de>
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/functions/src_unpack/rpm-sources/text.xml | 6 ++
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
index 0029c53..99c932e 100644
--- a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
+++ b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
@@ -25,10 +25,8 @@ manner such as:
src_unpack() {
- rpm_src_unpack ${A}
- cd "${S}"
-
- use ssl && eapply "${FILESDIR}/${PV}/${P}-ssl.patch"
+ unpack ${A}
+ rpm_unpack "${S}/rpm/intel-openclrt-${PV}-${ALT_PV}.x86_64.rpm"
}
[gentoo-commits] proj/devmanual:master commit in: archs/x86/
commit: d82ec66bf6de4d1dd44584c92305b38efa5f9b7a Author: Sebastian Engel gmx de> AuthorDate: Wed Aug 28 11:54:42 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 14 19:10:59 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d82ec66b archs/x86: Remove some outdated team guidelines Signed-off-by: Sebastian Engel gmx.de> Signed-off-by: Ulrich Müller gentoo.org> archs/x86/text.xml | 6 -- 1 file changed, 6 deletions(-) diff --git a/archs/x86/text.xml b/archs/x86/text.xml index 59a3f68..9fb3ef5 100644 --- a/archs/x86/text.xml +++ b/archs/x86/text.xml @@ -28,12 +28,6 @@ The following is a list of rules and expectations for members of the x86 team: - -Assist/resolve 4 bugs a month that are assigned to the team - - -Be present in our IRC channel, #gentoo-x86/irc.libera.chat - If you need one of your packages stable, file a bug to the team. You are not exempt from the same rules everyone else must follow.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/portage-cache/
commit: ba3631b0b62ec1d9912a77ed68db8505328953bb Author: Sebastian Engel gmx de> AuthorDate: Wed Aug 28 08:47:02 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 14 19:10:58 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ba3631b0 g-c/portage-cache: Refine the allowed variables for conditional inherits 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> general-concepts/portage-cache/text.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/general-concepts/portage-cache/text.xml b/general-concepts/portage-cache/text.xml index ad2b391..aaee0b9 100644 --- a/general-concepts/portage-cache/text.xml +++ b/general-concepts/portage-cache/text.xml @@ -58,7 +58,8 @@ fi Because eclasses modify various cached variables, conditional inheritance is not allowed except where the same results will always be obtained on every system. For example, inherits based upon USE flags are illegal, but inherits based -solely upon PN are allowed. +solely upon the unchanging variables (e.g. PV) mentioned above are +allowed.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/messages/
commit: b8cea57c1a478d72ac3e4499f17122b5e7f01232 Author: Sebastian Engel gmx de> AuthorDate: Wed Aug 28 12:03:42 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 14 19:10:59 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b8cea57c ebuild-writing/messages: Change ewarn to eqawarn in the example code 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/messages/text.xml | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ebuild-writing/messages/text.xml b/ebuild-writing/messages/text.xml index 830e3cf..c8c92b5 100644 --- a/ebuild-writing/messages/text.xml +++ b/ebuild-writing/messages/text.xml @@ -148,12 +148,12 @@ It would be better written as: -ewarn "The 'frozbinate' function provided by eutils.eclass is deprecated" -ewarn "in favour of frozbinate.eclass, but this package has not been" -ewarn "updated yet. If this is a package from the main tree, please check" -ewarn "https://bugs.gentoo.org/ and file a bug if there is not one already." -ewarn "If this is your own package, please read the comments in the" -ewarn "frozbinate eclass for instructions on how to convert." +eqawarn "The 'frozbinate' function provided by eutils.eclass is deprecated" +eqawarn "in favour of frozbinate.eclass, but this package has not been" +eqawarn "updated yet. If this is a package from the main tree, please check" +eqawarn "https://bugs.gentoo.org/ and file a bug if there is not one already." +eqawarn "If this is your own package, please read the comments in the" +eqawarn "frozbinate eclass for instructions on how to convert."
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/messages/
commit: 5ac5203cac1eac5178ed268350ba1c904eb2c023 Author: Sebastian Engel gmx de> AuthorDate: Thu Aug 29 14:32:25 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Aug 31 16:40:52 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5ac5203c ebuild-writing/messages: Remove history lesson 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/messages/text.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ebuild-writing/messages/text.xml b/ebuild-writing/messages/text.xml index 36daa14..830e3cf 100644 --- a/ebuild-writing/messages/text.xml +++ b/ebuild-writing/messages/text.xml @@ -38,9 +38,8 @@ internal is the simplest it simply displays its parameters as a message. The elog function can be used to display an informational message which is -meant to 'stand out' and is logged by the elog functionality in Portage 2.1 and -Paludis 0.6 or newer. On a colour terminal, the message provided will be prefixed -with a green asterisk. On earlier versions, elog behaves just like einfo. +meant to 'stand out' and is logged by Portage's elog functionality. On a colour +terminal, the message provided will be prefixed with a green asterisk.
[gentoo-commits] proj/devmanual:master commit in: tools-reference/echo/
commit: 60b9d214f4454aea8451cc7fdf49035e707da7d9 Author: Sebastian Engel gmx de> AuthorDate: Thu Aug 29 14:21:00 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Aug 31 16:40:52 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=60b9d214 tools-reference/echo: Remove bash version history 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> tools-reference/echo/text.xml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tools-reference/echo/text.xml b/tools-reference/echo/text.xml index dba3452..404d319 100644 --- a/tools-reference/echo/text.xml +++ b/tools-reference/echo/text.xml @@ -43,8 +43,7 @@ of dealing with such cases. Here strings -As of >=bash-2.05b, the so-called "here strings" have been -introduced. Using "here strings", you can pass contents of an +Using "here strings", you can pass contents of an environment variable to the standard input of an application, using <<
[gentoo-commits] proj/devmanual:master commit in: tools-reference/echo/
commit: 0edced44c3bac79448fbf8b1620ecc2b39df Author: Sebastian Engel gmx de> AuthorDate: Mon Aug 12 21:29:44 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Aug 23 15:16:31 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=0edced44 tools-reference/echo: Format the word variable as inline code The devmanual commonly uses 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> tools-reference/echo/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools-reference/echo/text.xml b/tools-reference/echo/text.xml index 9bce77c..dba3452 100644 --- a/tools-reference/echo/text.xml +++ b/tools-reference/echo/text.xml @@ -47,7 +47,7 @@ As of >=bash-2.05b, the so-called "here strings" have been introduced. Using "here strings", you can pass contents of an environment variable to the standard input of an application, using <<
[gentoo-commits] proj/devmanual:master commit in: tools-reference/grep/
commit: 4ee7af98596ae8bc646a4d7a0c99197cedb048c1 Author: Sebastian Engel gmx de> AuthorDate: Mon Aug 12 21:18:40 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Aug 23 15:16:31 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4ee7af98 tools-reference/grep: Remove the phonetic spelling of the -l parameter Signed-off-by: Sebastian Engel gmx.de> Signed-off-by: Ulrich Müller gentoo.org> tools-reference/grep/text.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tools-reference/grep/text.xml b/tools-reference/grep/text.xml index b0651bd..1aa17ba 100644 --- a/tools-reference/grep/text.xml +++ b/tools-reference/grep/text.xml @@ -32,9 +32,8 @@ being a fixed string rather than a regular expression. By default, grep prints out matching lines from the input. If --q is specified, no output is displayed. If -l (lowercase -letter ell) is specified, only the filenames of files which contain -matching lines are displayed. +-q is specified, no output is displayed. If -l is specified, +only the filenames of files which contain matching lines are displayed.
[gentoo-commits] proj/devmanual:master commit in: tools-reference/echo/
commit: 9a7164477f77f5346e32d6073932018bdae70961
Author: Sebastian Engel gmx de>
AuthorDate: Mon Aug 12 20:35:40 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Fri Aug 23 15:16:25 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9a716447
tools-reference/echo: Improve wording in abuse chapter
"should be used as less as possible" is not a correct expression,
use "should be avoided" instead.
Signed-off-by: Sebastian Engel gmx.de>
Signed-off-by: Ulrich Müller gentoo.org>
tools-reference/echo/text.xml | 12 ++--
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/tools-reference/echo/text.xml b/tools-reference/echo/text.xml
index f72d833..9bce77c 100644
--- a/tools-reference/echo/text.xml
+++ b/tools-reference/echo/text.xml
@@ -29,12 +29,12 @@ the same as the former, but they won't print the trailing
newline
All usage of the form echo ${somevar} | grep substring just to
-check if the content of the ${somevar} variable
-contains substring, or more often, echo ${somevar} |
-command, is deprecated and should be (and in most cases, can be)
-used as less as possible: doing so involves for no reason an
-additional shell session and a pipe. The "here strings" section
-describes the preferred way of dealing with such cases.
+check if the content of the ${somevar} variable contains
+substring, or more often, echo ${somevar} | command,
+is deprecated and should be (and in most cases, can be) avoided:
+doing so involves for no reason an additional shell session and a pipe.
+The "here strings" section describes the preferred way
+of dealing with such cases.
[gentoo-commits] proj/devmanual:master commit in: function-reference/query-functions/, general-concepts/dependencies/
commit: 3169c493641486a6793229700af83c75b1d0e5a8 Author: Sebastian Engel gmx de> AuthorDate: Mon Aug 12 20:43:15 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Aug 23 15:16:30 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3169c493 g-c/dependencies + f-r/query-functions: Remove double if constraints 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 gmx.de> Signed-off-by: Ulrich Müller gentoo.org> function-reference/query-functions/text.xml | 2 +- general-concepts/dependencies/text.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/function-reference/query-functions/text.xml b/function-reference/query-functions/text.xml index 529bb77..49de81b 100644 --- a/function-reference/query-functions/text.xml +++ b/function-reference/query-functions/text.xml @@ -23,7 +23,7 @@ query variables and similar state. use flagname - Returns a true value if and only if flagname is enabled. + Returns a true value if flagname is enabled, false otherwise. The condition is inverted if prefixed with an exclamation mark, !flagname. It is guaranteed that use produces no output. diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index 3201d91..6c3207d 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -462,7 +462,7 @@ sub-slot changes of wombat:0 should be ignored. -To depend upon a certain package if and only if a given USE flag is set: +To depend upon a certain package only if a given USE flag is set:
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/, quickstart/, ebuild-writing/common-mistakes/, ...
commit: c08a1dc1072740182e5c4d059967db697897bed6
Author: Sebastian Engel gmx de>
AuthorDate: Mon Aug 12 09:12:05 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Mon Aug 12 14:06:51 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c08a1dc1
Fix multiple typos and grammatical errors
Signed-off-by: Sebastian Engel gmx.de>
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/common-mistakes/text.xml | 2 +-
ebuild-writing/eapi/text.xml| 2 +-
quickstart/text.xml | 2 +-
tasks-reference/pam/text.xml| 18 +-
tools-reference/echo/text.xml | 4 ++--
tools-reference/find/text.xml | 2 +-
6 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml
b/ebuild-writing/common-mistakes/text.xml
index e39e2e6..0b6adb8 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -263,7 +263,7 @@ bug about that ebuild.
You should try not to include version numbers in the SRC_URI and S. Always try
to use ${PV} or ${P}. It makes maintaining the ebuild much easier. If a version
-number is not consistent with the tarball/source, then use MY_P. An example
+number is not consistent with the tarball/source, then use MY_P. For example
dev-python/pyopenal fetches a tarball called PyOpenAL, so we redefine it like:
diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 4943dba..5c2f9b7 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -1009,7 +1009,7 @@ pkg_postrm() {
-In the example provided above, the ebuild needs to be update the icon cache
+In the example provided above, the ebuild needs to update the icon cache
upon being installed or uninstalled. By placing the respective tool in
IDEPEND, the ebuild requests it to be available at the time of
pkg_postinst. When cross-compiling, the tool will be built for
diff --git a/quickstart/text.xml b/quickstart/text.xml
index 32e3ede..9e22dfd 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -74,7 +74,7 @@ At the top of the ebuild is a header block. This is present
in all ebuilds.
-Ebuilds are indented using tabs, with each tab representing four places.
+Ebuilds are indented using tabs, with each tab representing four spaces.
See .
diff --git a/tasks-reference/pam/text.xml b/tasks-reference/pam/text.xml
index 3094b20..2cc794c 100644
--- a/tasks-reference/pam/text.xml
+++ b/tasks-reference/pam/text.xml
@@ -80,15 +80,15 @@ The statement is composed of 3 or 4 tokens:
methods. Some documentation states that we need to specify the full path
of
the module, but this creates problems because not all the systems install
the
modules in the same place: Linux-PAM on Gentoo is generally set up to load
-them from /lib/security, but for example on AMD64 this become
+them from /lib/security, but for example on AMD64 this becomes
/lib64/security. The
result is that providing the full path will lead to non-working pamd
-files, and the right way to handle this is just states the module name the
+files, and the right way to handle this is to just state the module name
the
PAM implementation will take care of finding the module.
-The last token, which can consist of multiple items, describe the
parameters
-passed to the module. These are module-dependent.
+The last token, which can consist of multiple items, describes the
+parameters passed to the module. These are module-dependent.
@@ -124,7 +124,7 @@ source for some services, such as mail and ftp servers.
But for desktop systems, all the different services, such as mail servers, ftp
-servers, ssh and so on, just need to authenticate in the same way the users
logs
+servers, ssh and so on, just need to authenticate in the same way the users log
in to the system.
@@ -175,13 +175,13 @@ for pamd files (dopamd and newpamd,
whose usage is the same
similar do* and new* functions) and the /etc/security
files
(dopamsecurity and newpamsecurity, which need the first argument
to be
the subdirectory of /etc/security in which the files are to be
installed).
-Those groups of functions already takes care of verifying whether the
pam
+Those groups of functions already take care of verifying whether the pam
USE flag is made optional for the package if this is the case, and the
flag
is disabled, the pamd files are just skipped.
-Many pamd files just uses one or more auth types from
system-auth login class,
+Many pamd files just use one or more auth types from system-auth
login class,
which is the base one which provides login facilities for most services on
common desktop systems. Instead of adding a pamd file in
${FILESDIR}
for this, one can use the pamd_mimic_system function. This function
takes a series
@@
[gentoo-commits] proj/devmanual:master commit in: /
commit: 238430eec3228209678c53fb8a78817cb17f7789 Author: Ulrich Müller gentoo org> AuthorDate: Tue Jul 30 14:29:54 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Jul 30 14:29:54 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=238430ee devbook.xsl: Use self-closing tags when possible This makes no difference for the HMTL output, i.e. xsltproc will expand to . Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 44 ++-- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 5df9686..0a3d7d8 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -559,23 +559,23 @@ - https://get.gentoo.org/"; role="button" class="btn get-gentoo"> Get Gentoo! + https://get.gentoo.org/"; role="button" class="btn get-gentoo"> Get Gentoo! -gentoo.org sites +gentoo.org sites - https://www.gentoo.org/"; title="Main Gentoo website"> gentoo.org - https://wiki.gentoo.org/"; title="Find and contribute documentation"> Wiki - https://bugs.gentoo.org/"; title="Report issues and find common issues"> Bugs - https://forums.gentoo.org/"; title="Discuss with the community"> Forums - https://packages.gentoo.org/"; title="Find software for your Gentoo"> Packages + https://www.gentoo.org/"; title="Main Gentoo website"> gentoo.org + https://wiki.gentoo.org/"; title="Find and contribute documentation"> Wiki + https://bugs.gentoo.org/"; title="Report issues and find common issues"> Bugs + https://forums.gentoo.org/"; title="Discuss with the community"> Forums + https://packages.gentoo.org/"; title="Find software for your Gentoo"> Packages - https://planet.gentoo.org/"; title="Find out what's going on in the developer community"> Planet - https://archives.gentoo.org/"; title="Read up on past discussions"> Archives - https://sources.gentoo.org/"; title="Browse our source code"> Sources + https://planet.gentoo.org/"; title="Find out what's going on in the developer community"> Planet + https://archives.gentoo.org/"; title="Read up on past discussions"> Archives + https://sources.gentoo.org/"; title="Browse our source code"> Sources - https://infra-status.gentoo.org/"; title="Get updates on the services provided by Gentoo"> Infra Status + https://infra-status.gentoo.org/"; title="Get updates on the services provided by Gentoo"> Infra Status @@ -598,9 +598,9 @@ Toggle navigation - - - + + + @@ -609,7 +609,7 @@ Home -Index +Index @@ -622,7 +622,7 @@ - +
[gentoo-commits] proj/devmanual:master commit in: general-concepts/copyright-policy/
commit: fdc98e37df5ab45c00e1ba6347bd619ac623ac9d Author: Ulrich Müller gentoo org> AuthorDate: Thu Jul 25 08:44:31 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Jul 25 08:44:31 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fdc98e37 general-concepts/copyright-policy: Exceptions are granted by the Council See GLEP 76 update: https://gitweb.gentoo.org/data/glep.git/commit/?id=7f0ce454b2359ed742b84d1d60176fadad15c066 Signed-off-by: Ulrich Müller gentoo.org> general-concepts/copyright-policy/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general-concepts/copyright-policy/text.xml b/general-concepts/copyright-policy/text.xml index 5fb9d19..2b97939 100644 --- a/general-concepts/copyright-policy/text.xml +++ b/general-concepts/copyright-policy/text.xml @@ -35,7 +35,7 @@ following licenses: Exceptions for other (GPL-incompatible) free software licenses may be granted -by the Gentoo Foundation on a case-by-case basis. +by the Gentoo Council on a case-by-case basis.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
commit: 1bb6533cefdf26958aa2500f6a31fb5f8a584985 Author: Ulrich Müller gentoo org> AuthorDate: Wed Jul 24 14:14:30 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jul 24 14:14:30 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1bb6533c ebuild-writing/common-mistakes: Delete P0 from list of custom variables As discussed in #gentoo-qa. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/common-mistakes/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml index 134990c..e39e2e6 100644 --- a/ebuild-writing/common-mistakes/text.xml +++ b/ebuild-writing/common-mistakes/text.xml @@ -244,7 +244,7 @@ The first two lines must look like this: You should never redefine those variables. Always use MY_P, MY_PN, MY_PV, -P0, etc. See other ebuilds that do it in Portage for more information. Most +etc. See other ebuilds that do it in Portage for more information. Most ebuilds use bash "Parameter Expansion". Please read the man page for bash to understand how "Parameter Expansion" works.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/
commit: 91ac6474f078dc261807b535db75356cde91ac96 Author: Ulrich Müller gentoo org> AuthorDate: Fri Jul 5 20:15:04 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Jul 5 20:15:04 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=91ac6474 ebuild-writing/eapi: Add todo items for EAPIs 5 and 6 Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/eapi/text.xml | 14 ++ 1 file changed, 14 insertions(+) diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index 26795cf..4943dba 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -112,6 +112,13 @@ Manager Specification for details about them. EAPI 5 + + +EAPI 5 is deprecated and should no longer appear here. The information needs to +be split up and moved to other sections. + + + EAPI 5 metadata @@ -297,6 +304,13 @@ If USE flag is set, echo [true output][true suffix] (defaults to "yes"), EAPI 6 + + +EAPI 6 is deprecated and should no longer appear here. The information needs to +be split up and moved to other sections. + + + EAPI 6 Bash version
[gentoo-commits] proj/devmanual:master commit in: function-reference/message-functions/, ebuild-writing/messages/
commit: 63daacc6d9af98707c0d5369c6b586fd75f0c87a Author: Ulrich Müller gentoo org> AuthorDate: Wed Jun 5 18:25:17 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Jul 5 19:59:19 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=63daacc6 ebuild-writing, function-reference: Update eqawarn documentation No longer mention eutils.eclass for eqawarn. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/messages/text.xml | 7 --- function-reference/message-functions/text.xml | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/ebuild-writing/messages/text.xml b/ebuild-writing/messages/text.xml index fe05e6b..36daa14 100644 --- a/ebuild-writing/messages/text.xml +++ b/ebuild-writing/messages/text.xml @@ -99,9 +99,10 @@ is mainly used for displaying additional error details before bailing out. - The eqawarn function can be used by eclass authors to notify ebuild writers about - deprecated functionality. eqawarn is defined in eutils prior to EAPI=7. Portage doesn't log the qa message - class by default so users don't get annoyed by seeing messages they can't do much about. +The eqawarn function can be used by eclass authors to notify ebuild +writers about deprecated functionality. Portage doesn't log the qa message +class by default so users don't get annoyed by seeing messages they can't do +much about. diff --git a/function-reference/message-functions/text.xml b/function-reference/message-functions/text.xml index cde7eb6..2657dfb 100644 --- a/function-reference/message-functions/text.xml +++ b/function-reference/message-functions/text.xml @@ -79,8 +79,8 @@ displaying informational messages. eqawarn - Used by eclass authors to notify ebuild writers that they are using deprecated functionality. - Before EAPI=7, the eutils eclass must be inherited. + Used by eclass authors to notify ebuild writers that they are using + deprecated functionality.
[gentoo-commits] proj/devmanual:master commit in: function-reference/version-functions/, general-concepts/portage-cache/, ...
commit: 571dd5d10072e7ce6b7126187be454d8891aff16 Author: Ulrich Müller gentoo org> AuthorDate: Wed Jun 5 13:42:31 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Jul 5 19:59:05 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=571dd5d1 function-reference/version-functions: New chapter Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/variables/text.xml | 20 +-- function-reference/text.xml | 1 + function-reference/version-functions/text.xml | 219 ++ general-concepts/portage-cache/text.xml | 6 +- 4 files changed, 229 insertions(+), 17 deletions(-) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 97e5995..06c92bf 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -767,14 +767,11 @@ expecting a tarball named Foo-1.2-3b.tar.bz2. Rather than hard coding the it is preferable to make MY_PN, MY_PV and MY_P variables and use those to define the upstream naming. EAPI=7 debuted a new set of functions, ver_cut, ver_rs and ver_test. -These were backported into older EAPIs with the eapi7-ver eclass. The easy way of redefining the version, which should be used unless you are sure you know what you are doing, is to use these functions: -inherit eapi7-ver - MY_PN="Foo" # Replace the second period separator in PV with - MY_PV=$(ver_rs 2 '-') @@ -787,24 +784,21 @@ switches to a format like Foo-1.3-4.5.tar.bz2 (yes, this really happens). -It is also possible to use bash substitution to achieve the same effect (this is -how eapi7-ver works internally), but this is complicated, error prone and hard -to read. +It is also possible to use bash substitution to achieve the same effect, but +this is complicated, error-prone and hard to read. Some ebuilds use calls to sed, awk and / or cut to do this. This must not be done for any new code and should be fixed to use -built-in version manipulation commands (for EAPI 7 or later), Bash substitution, -or in older EAPIs before 7, eapi7-ver. Global scope non-Bash code is -strongly discouraged. +the built-in version manipulation commands or Bash substitution. Global scope +non-Bash code is strongly discouraged. -The ver_ functions are used extract particular components -from a version string. See man eapi7-ver.eclass and the eclass source code -for further documentation and examples. A brief summary of the functions -follows. +The ver_ functions are used extract particular components from a version +string. See for further +documentation and examples. A brief summary of the functions follows. diff --git a/function-reference/text.xml b/function-reference/text.xml index d8e844f..efabc3d 100644 --- a/function-reference/text.xml +++ b/function-reference/text.xml @@ -23,5 +23,6 @@ The following functions are available for use in ebuilds: + diff --git a/function-reference/version-functions/text.xml b/function-reference/version-functions/text.xml new file mode 100644 index 000..bf05ccc --- /dev/null +++ b/function-reference/version-functions/text.xml @@ -0,0 +1,219 @@ + + + +Version functions reference + + + +EAPI 7 introduced three commands for common version number operations: + + + + ver_cut obtains substrings of a version string + ver_rs replaces separators in a version string + ver_test compares two versions + + + + +Version strings + + + +The functions support arbitrary version strings consisting of version +components interspersed with (possibly empty) version separators. + + + +A version component can either consist purely of digits ([0-9]+) or +purely of uppercase and lowercase letters ([A-Za-z]+). A version +separator is either a string of any other characters ([^A-Za-z0-9]+), +or it occurs at the transition between a sequence of letters and a sequence +of digits, or vice versa. In the latter case, the version separator is an +empty string. + + + +The version is processed left-to-right, and each successive component is +assigned numbers starting with 1. The components are either split on version +separators or on boundaries between digits and letters (in which case the +separator between the components is empty). Version separators are assigned +numbers starting with 1 for the separator between 1st and 2nd components. +As a special case, if the version string starts with a separator, it is +assigned index 0. + + + +Examples: + + + + +Type +s +c +s +c +s +c +s +c +s +c + + +Index +0 +1 +1 +2 +2 +3 +3 +4 +4 +5 + + +1.2.3 + +1 +. +2 +. +3 + + + + + + +1.2b_alpha4 + +1 +. +2 + +b +_ +alpha + +4 + + +.11. +. +11 +. + + + + + + + + + + + + + + +Ranges + + + +A range can be sp
[gentoo-commits] proj/devmanual:master commit in: appendices/contributors/
commit: 2282269ea55f1d2b7ef0631e6f6a4e86699f2bd2 Author: Ulrich Müller gentoo org> AuthorDate: Tue Jun 11 16:25:54 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Jun 11 16:25:54 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2282269e appendices/contributors: DTD has been replaced by RELAX NG schema Signed-off-by: Ulrich Müller gentoo.org> appendices/contributors/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index 5ac92b7..e06b6a9 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -68,7 +68,7 @@ Misc , , , - DTD, XSL stylesheets, eclass conversion + RELAX NG schema, XSL stylesheets, eclass conversion
[gentoo-commits] proj/devmanual:master commit in: appendices/contributors/
commit: d37c5d6105c9690cce4be84155f56d00c4c8da7a Author: Ulrich Müller gentoo org> AuthorDate: Tue Jun 11 16:26:43 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Jun 11 16:26:43 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d37c5d61 appendices/contributors: Whitespace Signed-off-by: Ulrich Müller gentoo.org> appendices/contributors/text.xml | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index e06b6a9..91f3902 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -56,10 +56,10 @@ This page lists the contributions to the Gentoo Development Guide: XSL stylesheets, previous maintainer -, -, -, -Misc + , + , + , + Misc ,
[gentoo-commits] proj/devmanual:master commit in: /
commit: 10510e60c2f5b5e3a3cc9c54d5a8d38ea6288b1a
Author: Ulrich Müller gentoo org>
AuthorDate: Tue Jun 11 16:17:59 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Tue Jun 11 16:17:59 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=10510e60
Makefile: Check if /guide/@self agrees with the document path
Signed-off-by: Ulrich Müller gentoo.org>
Makefile | 7 +++
1 file changed, 7 insertions(+)
diff --git a/Makefile b/Makefile
index 1bfa86e..8f3014e 100644
--- a/Makefile
+++ b/Makefile
@@ -89,6 +89,13 @@ install: all
validate: devbook.rng
@xmllint --noout --quiet --relaxng $< $(XMLS)
+ @# Check if /guide/@self agrees with the document path
+ @for file in $(XMLS); do \
+ self=$$(xmllint --quiet --xpath 'string(/guide/@self)' $${file}); \
+ if test "$${self}text.xml" != "$${file#./}"; then \
+ echo "$${file}: bad self attribute '$${self}'"; exit 1; \
+ fi; \
+ done
@echo "xmllint validation successful"
%.rng: %.rnc
[gentoo-commits] proj/devmanual:master commit in: /
commit: daa56917313abaa5eaddf65492fc31795b1235fb Author: Ulrich Müller gentoo org> AuthorDate: Mon Jun 10 15:39:57 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Jun 10 15:39:57 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=daa56917 devbook.xsl: Rename parameter of repeat-string template Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index c9a1a1c..5df9686 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -300,8 +300,8 @@ - - + + @@ -311,7 +311,7 @@ -../ +../ @@ -435,7 +435,7 @@ -../ +../ @@ -522,7 +522,7 @@ - ../ + ../ @@ -894,7 +894,7 @@ - ../ + ../
[gentoo-commits] proj/devmanual:master commit in: general-concepts/tree/
commit: 4d099f483b70fcca7407d61462b5e8d70f26c834 Author: Ulrich Müller gentoo org> AuthorDate: Sun Jun 2 17:34:42 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 2 17:34:42 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4d099f48 Revert "general-concepts/tree: Allow @ in filenames" As it turns out, Portage will silently drop files containing an @ char during Manifest generation. See bug 411127 and bug 106544 for further reference. This reverts commit 38de9c654dd036b304b158a32b14dbe785327938. Signed-off-by: Ulrich Müller gentoo.org> general-concepts/tree/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml index 3a3dc99..f1877fd 100644 --- a/general-concepts/tree/text.xml +++ b/general-concepts/tree/text.xml @@ -91,7 +91,7 @@ Things that do not belong in the tree: Large patches Non-text files Photos of teletubbies - Files whose name contains characters outside [A-Za-z0-9._+@-] + Files whose name contains characters outside [A-Za-z0-9._+-] Files whose name starts with a dot, a hyphen, or a plus sign
[gentoo-commits] proj/devmanual:master commit in: general-concepts/tree/
commit: 38de9c654dd036b304b158a32b14dbe785327938 Author: Ulrich Müller gentoo org> AuthorDate: Sun Jun 2 06:16:25 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 2 06:16:25 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=38de9c65 general-concepts/tree: Allow @ in filenames As discussed in #gentoo-dev. Signed-off-by: Ulrich Müller gentoo.org> general-concepts/tree/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml index f1877fd..3a3dc99 100644 --- a/general-concepts/tree/text.xml +++ b/general-concepts/tree/text.xml @@ -91,7 +91,7 @@ Things that do not belong in the tree: Large patches Non-text files Photos of teletubbies - Files whose name contains characters outside [A-Za-z0-9._+-] + Files whose name contains characters outside [A-Za-z0-9._+@-] Files whose name starts with a dot, a hyphen, or a plus sign
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/removal/
commit: 885c63e2d3e414024d09a549b77352067ff9fe05 Author: Michał Górny gentoo org> AuthorDate: Wed May 8 09:49:37 2024 + Commit: Michał Górny gentoo org> CommitDate: Wed May 8 09:49:37 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=885c63e2 ebuild-maintenance/removal: Use the new PKGREMOVED resolution Signed-off-by: Michał Górny gentoo.org> ebuild-maintenance/removal/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-maintenance/removal/text.xml b/ebuild-maintenance/removal/text.xml index ebab645..f012528 100644 --- a/ebuild-maintenance/removal/text.xml +++ b/ebuild-maintenance/removal/text.xml @@ -55,7 +55,7 @@ When removing packages follow these steps: metadata.xml files of other packages. - Close open bugs as WONTFIX + Close open bugs as PKGREMOVED
[gentoo-commits] proj/devmanual:master commit in: /
commit: 7bbf2cfb18964e9a7cc51370b4adf06d765da817 Author: Ulrich Müller gentoo org> AuthorDate: Tue May 7 17:25:18 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 7 17:25:18 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7bbf2cfb devbook.xsl: Use abbreviated CC-BY-SA-4.0 in footer This agrees with the footer in other gentoo.org sites. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/devbook.xsl b/devbook.xsl index 91feffa..c9a1a1c 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -727,7 +727,7 @@ https://www.gnu.org/licenses/gpl-2.0.html";>GNU General Public License, version 2. -https://creativecommons.org/licenses/by-sa/4.0/";>Creative Commons Attribution-ShareAlike 4.0 International License. +https://creativecommons.org/licenses/by-sa/4.0/";>CC-BY-SA-4.0 license. The https://www.gentoo.org/inside-gentoo/foundation/name-logo-guidelines.html";>Gentoo Name and Logo Usage Guidelines apply.
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
commit: c09e7231f8c24cc0235abd494d8849a24138b76c Author: Ulrich Müller gentoo org> AuthorDate: Mon Apr 29 21:22:48 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 7 17:21:45 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c09e7231 devbook-guide: Document that sentence case should be used in titles Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 6 ++ 1 file changed, 6 insertions(+) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 5c4aec7..c725307 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -696,6 +696,12 @@ with a capital letter. + +Titles should use sentence case, i.e. their first word should start with a +capital letter, and all other words (except proper nouns) should be in lower +case. + + Try to usewith the link attribute as much as possible. In other words, the
[gentoo-commits] proj/devmanual:master commit in: profiles/use.desc/, profiles/categories/, general-concepts/use-flags/, ...
commit: fe83e878973e099e915891041bd7ab7846915f9e
Author: Ulrich Müller gentoo org>
AuthorDate: Mon Apr 29 16:44:57 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Tue May 7 17:16:54 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fe83e878
More sentence case changes
Apparently these have been missed previously.
Signed-off-by: Ulrich Müller gentoo.org>
appendices/contributors/text.xml| 8
bin/gen-eclass-html.sh | 6 +++---
ebuild-writing/common-mistakes/text.xml | 4 ++--
ebuild-writing/misc-files/metadata/text.xml | 2 +-
general-concepts/use-flags/text.xml | 2 +-
profiles/categories/text.xml| 2 +-
profiles/use.desc/text.xml | 2 +-
7 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml
index da7fe3b..5ac92b7 100644
--- a/appendices/contributors/text.xml
+++ b/appendices/contributors/text.xml
@@ -10,7 +10,7 @@ This page lists the contributions to the Gentoo Development
Guide:
- Main Content
+ Main content
@@ -50,10 +50,10 @@ This page lists the contributions to the Gentoo Development
Guide:
- Previous maintainer (XSL Stylesheets, legacy Developer Handbook content)
+ Previous maintainer (XSL stylesheets, legacy Developer Handbook content)
- XSL Stylesheets, previous maintainer
+ XSL stylesheets, previous maintainer
,
@@ -68,7 +68,7 @@ Misc
,
,
,
- DTD, XSL stylesheet, eclass conversion
+ DTD, XSL stylesheets, eclass conversion
diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh
index 2d40cb6..cdd5244 100755
--- a/bin/gen-eclass-html.sh
+++ b/bin/gen-eclass-html.sh
@@ -51,8 +51,8 @@ IFS='' read -r -d '' HEADER << 'EOF'
-Master Index
-Eclass Reference
+Master index
+Eclass reference
@@ -171,7 +171,7 @@ cat << 'EOF' > "${OUTPUTDIR}"/text.xml || exit 1
-Eclass Reference
+Eclass reference
diff --git a/ebuild-writing/common-mistakes/text.xml
b/ebuild-writing/common-mistakes/text.xml
index 5db3973..134990c 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -442,12 +442,12 @@ HTTPS support for the site used in HOMEPAGE.
-Wrongfully used spaces instead of TABS
+Wrongfully used spaces instead of TABs
It is no fun reformatting lines of ebuilds because the submitter did not follow
-the guidelines to use TABS rather than spaces. So please use tabs!
+the guidelines to use TABs rather than spaces. So please use TABs!
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index 04a4164..4d549f4 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -625,7 +625,7 @@ specified in the tag.
-Maintainer-Needed
+Maintainer-needed
diff --git a/general-concepts/use-flags/text.xml
b/general-concepts/use-flags/text.xml
index 6a32e61..2b893df 100644
--- a/general-concepts/use-flags/text.xml
+++ b/general-concepts/use-flags/text.xml
@@ -237,7 +237,7 @@ IUSE="+bar foo"
-Local and Global USE Flags
+Local and global USE flags
diff --git a/profiles/categories/text.xml b/profiles/categories/text.xml
index c6bfa49..81079b2 100644
--- a/profiles/categories/text.xml
+++ b/profiles/categories/text.xml
@@ -1,7 +1,7 @@
-Profiles categories File
+Profiles categories file
diff --git a/profiles/use.desc/text.xml b/profiles/use.desc/text.xml
index 3ea5f65..0a4e9a3 100644
--- a/profiles/use.desc/text.xml
+++ b/profiles/use.desc/text.xml
@@ -26,7 +26,7 @@ so you must never edit it directly.
Having a small number of packages using identically named local USE
flags is
allowed. If the number starts to grow substantially, it may be worth proposing
that the flag becomes a global see
-.
+.
[gentoo-commits] proj/devmanual:master commit in: tools-reference/sed/, tasks-reference/completion/, ...
commit: fb8f7e599d39a1f4f7b1250e8ae64a7feac742e7 Author: Matthew Marchese gentoo org> AuthorDate: Thu Dec 21 12:17:53 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 7 17:16:52 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fb8f7e59 Sentence case devmanual Signed-off-by: Matthew Marchese gentoo.org> [Whitespace. Fix rebase artifact in ebuild-writing/functions/src_test.] Signed-off-by: Ulrich Müller gentoo.org> appendices/common-problems/text.xml| 14 +++--- appendices/contributing/text.xml | 8 ++-- appendices/devbook-guide/text.xml | 10 ++--- appendices/editor-configuration/emacs/text.xml | 2 +- appendices/editor-configuration/text.xml | 2 +- appendices/further-reading/text.xml| 2 +- appendices/todo-list/text.xml | 2 +- archs/alpha/text.xml | 12 ++--- archs/amd64/text.xml | 51 +++--- archs/mips/text.xml| 8 ++-- archs/ppc/text.xml | 8 ++-- archs/sparc/text.xml | 10 ++--- archs/text.xml | 2 +- archs/x86/text.xml | 6 +-- ebuild-maintenance/git/text.xml| 4 +- ebuild-maintenance/new-ebuild/text.xml | 6 +-- ebuild-maintenance/package-moves/text.xml | 2 +- ebuild-maintenance/removal/text.xml| 2 +- ebuild-maintenance/text.xml| 2 +- ebuild-writing/common-mistakes/text.xml| 18 ebuild-writing/eapi/text.xml | 28 ++-- ebuild-writing/error-handling/text.xml | 12 ++--- ebuild-writing/file-format/text.xml| 10 ++--- ebuild-writing/functions/pkg_postinst/text.xml | 2 +- ebuild-writing/functions/pkg_postrm/text.xml | 2 +- ebuild-writing/functions/pkg_preinst/text.xml | 2 +- ebuild-writing/functions/pkg_prerm/text.xml| 2 +- .../src_compile/build-environment/text.xml | 10 ++--- .../functions/src_compile/building/text.xml| 4 +- .../functions/src_compile/no-build-system/text.xml | 2 +- ebuild-writing/functions/src_compile/text.xml | 2 +- .../functions/src_configure/configuring/text.xml | 4 +- ebuild-writing/functions/src_configure/text.xml| 2 +- .../functions/src_install/docompress/text.xml | 2 +- ebuild-writing/functions/src_install/text.xml | 8 ++-- ebuild-writing/functions/src_prepare/text.xml | 2 +- .../functions/src_unpack/other-formats/text.xml| 8 ++-- .../functions/src_unpack/rpm-sources/text.xml | 4 +- ebuild-writing/functions/src_unpack/text.xml | 4 +- .../functions/src_unpack/vcs-sources/text.xml | 6 +-- ebuild-writing/functions/text.xml | 2 +- ebuild-writing/messages/text.xml | 8 ++-- ebuild-writing/misc-files/metadata/text.xml| 16 +++ ebuild-writing/misc-files/patches/text.xml | 6 +-- ebuild-writing/misc-files/text.xml | 2 +- ebuild-writing/text.xml| 2 +- ebuild-writing/use-conditional-code/text.xml | 2 +- ebuild-writing/user-submitted/text.xml | 2 +- ebuild-writing/users-and-groups/text.xml | 2 +- ebuild-writing/using-eclasses/text.xml | 4 +- ebuild-writing/variables/text.xml | 12 ++--- eclass-writing/text.xml| 24 +- function-reference/build-functions/text.xml| 2 +- function-reference/error-functions/text.xml| 2 +- function-reference/install-functions/text.xml | 2 +- function-reference/message-functions/text.xml | 2 +- function-reference/query-functions/text.xml| 2 +- function-reference/sandbox-functions/text.xml | 2 +- function-reference/text.xml| 2 +- general-concepts/autotools/text.xml| 28 ++-- general-concepts/config-protect/text.xml | 2 +- general-concepts/copyright-policy/text.xml | 2 +- general-concepts/dependencies/text.xml | 36 +++ general-concepts/ebuild-revisions/text.xml | 2 +- general-concepts/emerge-and-ebuild/text.xml| 2 +- general-concepts/git-to-rsync/text.xml | 2 +- general-concepts/install-destinations/text.xml | 2 +- general-concepts/licenses/text.xml | 2 +- general-concepts/mailing-lists/text.xml| 2 +- general-concepts/manifest/text.xml | 4 +- general-concepts/mirrors/text.xml | 10 ++--- general-concepts/news/text.xml | 2 +- general-concepts/overlay/text.xml | 2 +- general-concepts/
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/patches/
commit: 5196ecf9214c74aec620b0b0580e6264083a184a Author: Ulrich Müller gentoo org> AuthorDate: Mon Apr 29 16:19:17 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 7 17:16:52 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5196ecf9 ebuild-writing/misc-files/patches: Revert wording change This is referred to as the "Clean patch howto" from several other places. The wording change would also break links because the section title is used as fragment identifier. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/patches/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/misc-files/patches/text.xml b/ebuild-writing/misc-files/patches/text.xml index c71551b..239fd1b 100644 --- a/ebuild-writing/misc-files/patches/text.xml +++ b/ebuild-writing/misc-files/patches/text.xml @@ -172,7 +172,7 @@ allows them to be applied unconditionally. -Clean patch guide +Clean patch howto
[gentoo-commits] proj/devmanual:master commit in: function-reference/query-functions/, ebuild-writing/user-submitted/, ...
commit: fd9c0342503dd70838f2ecc75434d76349304079 Author: Ulrich Müller gentoo org> AuthorDate: Mon Apr 29 16:28:46 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 7 17:16:53 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd9c0342 Fix internal references Internal links referring to sections were broken by the previous "Sentence case devmanual" commit. Signed-off-by: Ulrich Müller gentoo.org> appendices/common-problems/text.xml | 8 appendices/contributors/text.xml| 8 appendices/devbook-guide/text.xml | 14 +++--- archs/alpha/text.xml| 2 +- archs/amd64/text.xml| 17 + archs/mips/text.xml | 2 +- archs/sparc/text.xml| 4 ++-- ebuild-maintenance/git/text.xml | 2 +- ebuild-writing/eapi/text.xml| 9 + ebuild-writing/file-format/text.xml | 4 ++-- ebuild-writing/functions/pkg_nofetch/text.xml | 2 +- .../functions/src_compile/build-environment/text.xml| 2 +- ebuild-writing/functions/src_test/text.xml | 2 +- ebuild-writing/functions/text.xml | 6 +++--- ebuild-writing/misc-files/metadata/text.xml | 4 ++-- ebuild-writing/misc-files/patches/text.xml | 4 ++-- ebuild-writing/use-conditional-code/text.xml| 2 +- ebuild-writing/user-submitted/text.xml | 2 +- ebuild-writing/variables/text.xml | 2 +- eclass-writing/text.xml | 2 +- function-reference/build-functions/text.xml | 2 +- function-reference/query-functions/text.xml | 4 ++-- function-reference/sandbox-functions/text.xml | 2 +- general-concepts/autotools/text.xml | 2 +- general-concepts/dependencies/text.xml | 4 ++-- general-concepts/ebuild-revisions/text.xml | 4 ++-- general-concepts/manifest/text.xml | 2 +- general-concepts/mirrors/text.xml | 3 ++- general-concepts/sandbox/text.xml | 2 +- general-concepts/slotting/text.xml | 4 ++-- general-concepts/tree/text.xml | 2 +- keywording/text.xml | 2 +- profiles/categories/text.xml| 2 +- profiles/use.mask/text.xml | 2 +- quickstart/text.xml | 7 --- tools-reference/bash/text.xml | 2 +- tools-reference/text.xml| 2 +- 37 files changed, 75 insertions(+), 71 deletions(-) diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml index 84bb610..6ebc098 100644 --- a/appendices/common-problems/text.xml +++ b/appendices/common-problems/text.xml @@ -59,8 +59,8 @@ in use, there are various alternatives: Usually when any of the above are used in global scope, it is to manipulate a version or program name string. These should be avoided in favour of pure bash constructs. The built-in helpers of EAPI 7 are useful here. See - -and . + +and . has_version, best_version @@ -101,7 +101,7 @@ for security reasons. If this message is shown, you have a couple of options: Use append-ldflags (see -) +) to add -Wl,-z,now. This will affect all binaries installed, not just the setXid ones. @@ -131,7 +131,7 @@ inheritance occurring. Most commonly: When working with eclasses in an overlay with a stale cache. See . +link="::general-concepts/overlay/#Overlay and eclasses"/>. When working with a stale Portage cache. diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index 2808df1..da7fe3b 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -13,7 +13,7 @@ This page lists the contributions to the Gentoo Development Guide: Main Content - + @@ -23,7 +23,7 @@ This page lists the contributions to the Gentoo Development Guide: , - + @@ -33,7 +33,7 @@ This page lists the contributions to the Gentoo Development Guide: , - + @@ -123,7 +123,7 @@ Misc Search functionality - + , diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 243017d..5c4aec7 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -533,12 +533,12 @@ here syndrome as recommended by the DevBook XML makes it really easy to reference other parts of the docum
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_prepare/eapply/
commit: f465e69945491f750d1da23ae3793112f3f18a0f Author: Louis Sautier gentoo org> AuthorDate: Mon Apr 29 19:37:58 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 29 19:47:31 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f465e699 ebuild-writing/functions/src_prepare/eapply: fix typo Signed-off-by: Louis Sautier gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/functions/src_prepare/eapply/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/functions/src_prepare/eapply/text.xml b/ebuild-writing/functions/src_prepare/eapply/text.xml index 74295ee..97f4445 100644 --- a/ebuild-writing/functions/src_prepare/eapply/text.xml +++ b/ebuild-writing/functions/src_prepare/eapply/text.xml @@ -28,7 +28,7 @@ filename begins with a hyphen. -If an argument is a regular file, it will be applied it in the working +If an argument is a regular file, it will be applied in the working directory by calling GNU patch with patch level -p1. Specifying an explicit -pN option will override the default patch level.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/licenses/
commit: 5788aaadff50c5f29290cf7aa5d32c3932cd7e1f Author: Ulrich Müller gentoo org> AuthorDate: Mon Apr 29 10:35:13 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 29 18:34:09 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5788aaad general-concepts/licenses: Licenses must be plain text Historically we had some PDF files in the repository, but the last of them was removed in 2011. Signed-off-by: Ulrich Müller gentoo.org> general-concepts/licenses/text.xml | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/general-concepts/licenses/text.xml b/general-concepts/licenses/text.xml index 182cfb6..939b429 100644 --- a/general-concepts/licenses/text.xml +++ b/general-concepts/licenses/text.xml @@ -230,11 +230,11 @@ indicates GPL-2+ license: -If your package's license is not already in the tree, you must add the -license before committing the package. When adding the license, use a -plain text file (UTF-8 encoded) if at all possible. Some licenses are -PDF files rather than plain text this should only be done if we -are legally required to do so. +If your package's license is not already in the tree, you must add the license +before committing the package. When adding the license, use a plain text file +(UTF-8 encoded), because non-text files +do not belong +in the repository. Finally you need to check if your license should be added to a license group as listed in the repository's profiles/license_groups file. For more information see
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_install/, general-concepts/licenses/, ...
commit: 700187075bd0827c25eebf48c2460f3bf09ff758
Author: Ulrich Müller gentoo org>
AuthorDate: Mon Apr 29 06:48:37 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Mon Apr 29 06:50:48 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=70018707
No longer mention PORTDIR
Closes: https://bugs.gentoo.org/865455
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/functions/src_install/text.xml | 9 -
ebuild-writing/variables/text.xml | 5 ++---
general-concepts/licenses/text.xml| 3 ++-
general-concepts/overlay/text.xml | 6 +++---
4 files changed, 11 insertions(+), 12 deletions(-)
diff --git a/ebuild-writing/functions/src_install/text.xml
b/ebuild-writing/functions/src_install/text.xml
index 66a8e3d..d6589e9 100644
--- a/ebuild-writing/functions/src_install/text.xml
+++ b/ebuild-writing/functions/src_install/text.xml
@@ -120,11 +120,10 @@ to be installed recursively.
-There is no need to dodoc COPYING! The license belongs
-to ${PORTDIR}/licenses. Sometimes though, you might want to
-install COPYING regardless, if it explains how different
-licenses are applied to different parts of the application, for
-example.
+There is no need for dodoc COPYING! The license belongs in the
+repository's licenses/ directory. Sometimes though, you might want to
+install COPYING regardless, if it explains how different licenses are
+applied to different parts of the application, for example.
diff --git a/ebuild-writing/variables/text.xml
b/ebuild-writing/variables/text.xml
index af03749..67c9887 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -64,9 +64,8 @@ for these variables when writing ebuilds.
FILESDIR
- Path to the ebuild's files/ directory, commonly used
- for small patches and files. For example:
- "${PORTDIR}/${CATEGORY}/${PN}/files".
+ Path to the package's files/ directory, commonly used for small
+ patches and other files.
diff --git a/general-concepts/licenses/text.xml
b/general-concepts/licenses/text.xml
index a9fb702..182cfb6 100644
--- a/general-concepts/licenses/text.xml
+++ b/general-concepts/licenses/text.xml
@@ -236,7 +236,8 @@ plain text file (UTF-8 encoded) if at all possible. Some
licenses are
PDF files rather than plain text this should only be done if we
are legally required to do so.
Finally you need to check if your license should be added to a license group
-as listed in $PORTDIR/profiles/license_groups. For more information see the
+as listed in the repository's profiles/license_groups file. For more
+information see
https://www.gentoo.org/glep/glep-0023.html";>GLEP 23.
diff --git a/general-concepts/overlay/text.xml
b/general-concepts/overlay/text.xml
index 72463e9..43d1607 100644
--- a/general-concepts/overlay/text.xml
+++ b/general-concepts/overlay/text.xml
@@ -11,9 +11,9 @@ in one or more repos.conf files.
-The overlay should contain the same directory structure as PORTDIR
(although
-only the necessary directories need be included). For example, a simple overlay
-might have a directory structure like:
+The overlay should contain the same directory structure as the Gentoo
+repository (although only the necessary directories need be included).
+For example, a simple overlay might have a directory structure like:
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 924469d9fa9cc1b84073e0cbcab6199cfb013730 Author: Ulrich Müller gentoo org> AuthorDate: Wed Apr 24 14:13:01 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 24 14:13:01 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=924469d9 eclass-writing: Formatting fixes Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 9 + 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index cae3353..6575fcb 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -2,8 +2,8 @@ Eclass Writing Guide - + This section provides a brief introduction to eclass authoring. @@ -102,7 +102,6 @@ it is good etiquette to ping other developers in e.g. #gentoo-dev on IRC or informally determine if there are other similar changes (mainly documentation) which should be pushed at the same time in order to avoid unnecessary cache regeneration within a few hours or days of each other. - The same applies to your own work please prepare all of your commits and batch push them at once where possible. @@ -114,8 +113,10 @@ batch push them at once where possible. Removing Eclasses -No longer used eclasses may be removed from the tree, but developers must -adhere to the following process: + +No longer used eclasses may be removed from the tree, but developers must +adhere to the following process: +
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 064e969676cf9ce8774a347e05ba35e025952afa Author: Ulrich Müller gentoo org> AuthorDate: Wed Apr 24 14:09:50 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 24 14:09:50 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=064e9696 Revert "eclass-writing: @DEAD must be the first tag" eclass-to-manpages is now less strict about placement of the tag. This reverts commit cd392d0c6cd064ac3a138e678f4fe111afcc. Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 23c7219..2a6203f 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -129,9 +129,7 @@ adhere to the following process: Add a one line comment to the eclass, saying exactly # @DEAD so that -the eclass-manpages package will not attempt to document it. @DEAD -must be the first documentation tag in the eclass, i.e. it goes before -the @ECLASS tag. +the eclass-manpages package will not attempt to document it. Wait for the 30-day period to pass, then remove the eclass from the tree.
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 46eaf0892fe93c3d989f944dc6077fea44a5cee2 Author: Ulrich Müller gentoo org> AuthorDate: Wed Apr 24 14:12:21 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 24 14:12:21 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=46eaf089 eclass-writing: Add @DEAD tag to table Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 9 + 1 file changed, 9 insertions(+) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 2a6203f..cae3353 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -275,6 +275,15 @@ summarizes the available documentation tags: Replacement (or "none") Declares that this eclass should no longer be used + + @DEAD + No + + +For an eclass that is slated for removal; prevents the eclass-manpages +package from documenting the eclass. + + @DESCRIPTION: No
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 67a5bddbd0f99a6e82871738368d6f917ed7c017 Author: Ulrich Müller gentoo org> AuthorDate: Wed Apr 24 16:09:52 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 24 16:09:52 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=67a5bddb eclass-writing: Some updates from patch review Suggested by mjo and sam. Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 6575fcb..a8d373a 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -114,8 +114,8 @@ batch push them at once where possible. -No longer used eclasses may be removed from the tree, but developers must -adhere to the following process: +Eclasses that are no longer in use may be removed from the tree, but developers +must adhere to the following process: @@ -139,8 +139,8 @@ adhere to the following process: Before considering removal, please mark the eclass as # @DEPRECATED: -to ensure consumers are warned if they are still using the eclass. Do this -for a period before removing the eclass. +to ensure consumers are warned if they are still using the eclass. Do this at +least 30 days before removing the eclass.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_prepare/eapply/
commit: 363177edeccf80013e266e2b6fcadeb24d67a7ac Author: Ulrich Müller gentoo org> AuthorDate: Tue Apr 23 08:50:45 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Apr 23 08:50:45 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=363177ed ebuild-writing/functions/src_prepare/eapply: Clarify eapply for dir Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/functions/src_prepare/eapply/text.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ebuild-writing/functions/src_prepare/eapply/text.xml b/ebuild-writing/functions/src_prepare/eapply/text.xml index a543272..74295ee 100644 --- a/ebuild-writing/functions/src_prepare/eapply/text.xml +++ b/ebuild-writing/functions/src_prepare/eapply/text.xml @@ -34,11 +34,11 @@ filename begins with a hyphen. patch level. -For a directory, patch -p1 applies all patch files with names ending +For a directory, eapply applies all patch files with names ending in .diff or .patch in that directory, in POSIXbetical order of their names. Any other files in the directory are ignored. -Again, -pN can be used to override the default patch level. -Note that eapply will not recurse into subdirectories. +Again, -pN can be used to override the default -p1 +patch level. Note that eapply will not recurse into subdirectories.
[gentoo-commits] proj/devmanual:master commit in: tools-reference/diff-and-patch/, quickstart/, appendices/contributors/, ...
commit: faa071db197932e90d098907e16b071ccce05402
Author: Ulrich Müller gentoo org>
AuthorDate: Sat Apr 13 18:56:47 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Apr 21 10:00:04 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=faa071db
ebuild-writing/functions/src_prepare: Rename epatch chapter to eapply
Update references throughout.
Signed-off-by: Ulrich Müller gentoo.org>
appendices/contributors/text.xml | 2 +-
ebuild-writing/functions/src_prepare/{epatch => eapply}/text.xml | 2 +-
ebuild-writing/functions/src_prepare/text.xml| 2 +-
quickstart/text.xml | 2 +-
tools-reference/diff-and-patch/text.xml | 2 +-
5 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml
index 06a6e0c..2808df1 100644
--- a/appendices/contributors/text.xml
+++ b/appendices/contributors/text.xml
@@ -117,7 +117,7 @@ Misc
,
,
-
+
Search functionality
diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml
b/ebuild-writing/functions/src_prepare/eapply/text.xml
similarity index 98%
rename from ebuild-writing/functions/src_prepare/epatch/text.xml
rename to ebuild-writing/functions/src_prepare/eapply/text.xml
index ba77549..866008a 100644
--- a/ebuild-writing/functions/src_prepare/epatch/text.xml
+++ b/ebuild-writing/functions/src_prepare/eapply/text.xml
@@ -1,5 +1,5 @@
-
+
Patching with epatch and eapply
diff --git a/ebuild-writing/functions/src_prepare/text.xml
b/ebuild-writing/functions/src_prepare/text.xml
index b7c1b9a..7f515bb 100644
--- a/ebuild-writing/functions/src_prepare/text.xml
+++ b/ebuild-writing/functions/src_prepare/text.xml
@@ -95,6 +95,6 @@ when writing src_prepare functions.
-
+
diff --git a/quickstart/text.xml b/quickstart/text.xml
index c66f4ac..f493f44 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -301,7 +301,7 @@ Note the ${FILESDIR}/${P}-destdir.patch this
refers to
subdirectory in the Gentoo repository. Larger patch files must go on your
developer's space at dev.gentoo.org rather than in files/ or
mirrors see and
-.
+.
diff --git a/tools-reference/diff-and-patch/text.xml
b/tools-reference/diff-and-patch/text.xml
index 939e01e..d271445 100644
--- a/tools-reference/diff-and-patch/text.xml
+++ b/tools-reference/diff-and-patch/text.xml
@@ -39,7 +39,7 @@ To apply a patch, use patch -pX < whatever.patch,
where X is a number representing the number of path components
which must be removed (typically this is 0 or 1). Within
ebuilds, use the eapply function instead see
-.
+.
[gentoo-commits] proj/devmanual:master commit in: /
commit: 5997a5ca884c7fd97f8f54261d01a8a8e554175c Author: Ulrich Müller gentoo org> AuthorDate: Sun Apr 21 10:33:25 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 22 11:55:31 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5997a5ca .gitignore: Ignore Emacs backup files Signed-off-by: Ulrich Müller gentoo.org> .gitignore | 4 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 7c45b92..0809650 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,7 @@ .depend documents.js eclass-reference/ + +# Emacs backup files and locks +*~ +.#*
[gentoo-commits] proj/devmanual:master commit in: xsl/
commit: e41215d8fa7d630db9c8ddf8f862e13026895a4b Author: Ulrich Müller gentoo org> AuthorDate: Sat Apr 13 19:15:14 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Apr 22 11:55:30 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e41215d8 lang.highlight.ebuild.xsl: Drop epatch keyword Signed-off-by: Ulrich Müller gentoo.org> xsl/lang.highlight.ebuild.xsl | 2 -- 1 file changed, 2 deletions(-) diff --git a/xsl/lang.highlight.ebuild.xsl b/xsl/lang.highlight.ebuild.xsl index 30ccc08..f615393 100644 --- a/xsl/lang.highlight.ebuild.xsl +++ b/xsl/lang.highlight.ebuild.xsl @@ -53,8 +53,6 @@ cmake_src_prepare cmake_src_test cmake_use_find_package doicon domenu make_desktop_entry make_session_desktop newicon newmenu - -epatch all-flag-vars append-atomic-flags append-cflags append-cppflags append-cxxflags append-fflags append-flags append-ldflags append-lfs-flags append-libs filter-flags filter-ldflags filter-lfs-flags filter-lto filter-mfpmath
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_prepare/eapply/
commit: b599e3ba8a93655663ff6dae76d6117a8a455d66
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Apr 21 09:58:03 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Mon Apr 22 11:55:30 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b599e3ba
ebuild-writing/functions/src_prepare/eapply: Rework the chapter
Drop explanation of epatch. Rework the eapply sections and add
additional examples.
Signed-off-by: Ulrich Müller gentoo.org>
.../functions/src_prepare/eapply/text.xml | 203 -
1 file changed, 76 insertions(+), 127 deletions(-)
diff --git a/ebuild-writing/functions/src_prepare/eapply/text.xml
b/ebuild-writing/functions/src_prepare/eapply/text.xml
index 866008a..a543272 100644
--- a/ebuild-writing/functions/src_prepare/eapply/text.xml
+++ b/ebuild-writing/functions/src_prepare/eapply/text.xml
@@ -1,186 +1,135 @@
-Patching with epatch and eapply
-
+Patching with eapply
-
-The canonical way of applying patches in ebuilds is to
-use epatch (from epatch.eclass, which you must make sure
-to inherit!) inside src_prepare. This function automatically
-handles -p levels, gunzip and so on as necessary.
-
-Starting with EAPI=7, this function is banned and eapply must be used.
+The canonical way of applying patches in ebuilds is to use the package
+manager's eapply command, either by calling it explicitly, or by
+assigning the PATCHES variable supported by the default
+src_prepare implementation.
+
+Applying patches to the sources from the upstream tarball is strongly
+preferred to distributing your own modified tarball.
+
+
-Beginning with EAPI=6, a new function eapply was added to apply patches
-without the need for an eclass.
-This function differs from epatch in several ways:
+The eapply command takes one or more regular file or directory paths as
+its arguments. Optionally, these can be preceded by GNU patch options.
+
+The -- delimiter indicates the end of options. This is useful if a
+filename begins with a hyphen.
+
+
-eapply will not unpack patches for you.
-
-The default patch level is -p1.
-Other patch levels must be specified manually or the command will fail.
-
-
-When specifying a directory, at least one file with a name ending in .patch or
.diff
-must exist or the command fails. Other files are ignored.
-
+
+If an argument is a regular file, it will be applied it in the working
+directory by calling GNU patch with patch level -p1.
+Specifying an explicit -pN option will override the default
+patch level.
+
+
+For a directory, patch -p1 applies all patch files with names ending
+in .diff or .patch in that directory, in POSIXbetical order
+of their names. Any other files in the directory are ignored.
+Again, -pN can be used to override the default patch level.
+Note that eapply will not recurse into subdirectories.
+
-Note that distributing modified tarballs rather than a vanilla tarball
-and patches is highly discouraged.
+eapply was added in EAPI 6. It differs from the previously available
+epatch in several ways:
+
+
+
+eapply will not unpack patches for you.
+
+
+The patch level is no longer detected automatically. Patch levels other
+than -p1 must be specified manually.
+
+
+When specifying a directory, at least one file with a name ending in
+.diff or .patch must exist or the command fails.
+
+
Basic eapply
+
-The default src_prepare function will look for a global PATCHES array to apply
-a list of patches for you.
+In its simplest form, eapply takes a single filename and applies that
+patch. It will automatically die if the apply fails. The following is
+taken from sys-libs/gpm:
+
-PATCHES=(
- "${FILESDIR}/${P}-destdir.patch"
- "${FILESDIR}/${P}-parallel_build.patch"
-)
+ eapply "${FILESDIR}"/${P}-musl.patch
-
-
-
-Advanced eapply
-
-This example shows how different patch levels can be applied:
+In the following simplified example taken from www-client/firefox,
+a patchset is added to SRC_URI in order to fetch and unpack it.
+eapply is then called with a directory argument. It applies all patches
+found in that directory:
+SRC_URI+="https://dev.gentoo.org/~larry/patchsets/${P}-patches-01.tar.xz";
+
src_prepare() {
- eapply -p2 "${WORKDIR}/${P}-suse-update.patch"
- eapply -p0 "${FILESDIR}/${PV}-no-TIOCGDEV.patch"
- eapply "${FILESDIR}/${PV}-gcc-6.patch"
+ eapply "${WORKDIR}/firefox-patches"
eapply_user
}
-
-
-
-
-Basic epatch
-
-In its simplest form, epatch takes a single filename and
-applies that patch. It will automatically die if the apply
-fails. The following is taken from app-misc/detox:
+The chapter gives some
+guidelines about where patches should be hosted and about their formatting.
-
-src_prepare() {
- epatch "${FILESDIR}/${P}-destdir.patch"
- epatch "${FILESDIR}/${P}-parallel_build.patch"
-}
[gentoo-commits] proj/devmanual:master commit in: tools-reference/diff-and-patch/
commit: a1f06105dca95202204caa1c4ec931e28cd6793d Author: Ulrich Müller gentoo org> AuthorDate: Sat Apr 13 19:14:05 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Apr 21 08:35:43 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a1f06105 tools-reference/diff-and-patch: No longer mention epatch Signed-off-by: Ulrich Müller gentoo.org> tools-reference/diff-and-patch/text.xml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tools-reference/diff-and-patch/text.xml b/tools-reference/diff-and-patch/text.xml index 0e9755c..939e01e 100644 --- a/tools-reference/diff-and-patch/text.xml +++ b/tools-reference/diff-and-patch/text.xml @@ -38,8 +38,7 @@ than -u. For a verbose guide into patches and patching, see To apply a patch, use patch -pX < whatever.patch, where X is a number representing the number of path components which must be removed (typically this is 0 or 1). Within -ebuilds, use the epatch function, or eapply function -beginning with EAPI=6, instead — see +ebuilds, use the eapply function instead see .
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
commit: 4bdda4a2af6af15850924e1c4874aba0266a694d Author: Volkmar W. Pogatzki pogatzki net> AuthorDate: Thu Feb 29 08:50:58 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Apr 13 19:41:19 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4bdda4a2 ebuild-maintenance/git: drop repoman from commit message Signed-off-by: Volkmar W. Pogatzki pogatzki.net> Signed-off-by: Ulrich Müller gentoo.org> ebuild-maintenance/git/text.xml | 6 -- 1 file changed, 6 deletions(-) diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml index 8bef553..2f3fcb3 100644 --- a/ebuild-maintenance/git/text.xml +++ b/ebuild-maintenance/git/text.xml @@ -283,12 +283,6 @@ are optionally used in Gentoo: referenced, it will be closed (as fixed) automatically with reference to the commit. - -Package-Manager: Used by repoman to indicate Portage version - - -RepoMan-Options: Used by repoman to indicate repoman options -
[gentoo-commits] proj/devmanual:master commit in: /
commit: 5747c058d35a947d7b8fcd4f9776c7384c2b2d4a Author: Ulrich Müller gentoo org> AuthorDate: Sat Mar 23 07:10:39 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Mar 23 07:10:39 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5747c058 devbook.xsl: Add Gentoo e.V. to page footer Bug: https://bugs.gentoo.org/927555 Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/devbook.xsl b/devbook.xsl index 6f2e4e9..91feffa 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -718,7 +718,7 @@ Copyright (C) 2001-2024 Gentoo Authors -Gentoo is a trademark of the Gentoo Foundation, Inc. +Gentoo is a trademark of the Gentoo Foundation, Inc. and of Förderverein Gentoo e.V. The text of this document is distributed under the
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/
commit: c39ea4df4ce10b373177276ddc3bdfb1d4c26a3c Author: Ulrich Müller gentoo org> AuthorDate: Wed Feb 21 07:47:37 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Feb 21 07:47:37 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c39ea4df ebuild-writing/file-format: Update year in ebuild header Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/file-format/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml index ff7fb91..3772554 100644 --- a/ebuild-writing/file-format/text.xml +++ b/ebuild-writing/file-format/text.xml @@ -190,7 +190,7 @@ header.txt in the top directory of the Gentoo repository. -# Copyright 1999-2023 Gentoo Authors +# Copyright 1999-2024 Gentoo Authors # Distributed under the terms of the GNU General Public License v2
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: 5cb6b40137d1ce49d94f355dd15ddd512c2f8c7b Author: Michał Górny gentoo org> AuthorDate: Sun Jan 21 14:41:51 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Feb 8 11:14:10 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5cb6b401 package-moves: Allow moving back, and describe how to chain updates Make the rule forbidding reusing old package names less strict. There is no real reason not to move packages back — we can safely assume that the package manager will handle that just fine. The only real restriction is that no other package must reuse any of the old names, i.e. effectively cause the package manager to attempt merging the packages together. Add explicit rules for updating old package move entries. These match the logic used in pkgcheck, and therefore ensure both correct results and no warnings from pkgcheck. Signed-off-by: Michał Górny gentoo.org> [Replace Unicode subscripts by markup] Signed-off-by: Ulrich Müller gentoo.org> ebuild-maintenance/package-moves/text.xml | 50 +-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index eab8848..9c07db5 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -19,8 +19,10 @@ the following must be noted: Once an update entry is created, the old package name (or slot) cannot be -reused. Attempting to reuse it will cause updates to apply again, -to the reused name. This also means that updates cannot be undone. +reused for another package. Attempting to reuse it will cause updates to +apply again, to the reused name. This also means that while a package can +be moved back to its previous name, all the names historically used for +a package are reserved to it alone. Updates can only perform one-to-one moves. They cannot be used to merge @@ -113,6 +115,50 @@ you have updated every file in profiles/ directory that happens to contain an entry which may be affected by your change. + + + + +Updating prior update entries when moving the package again + + + +When the same package is moved again, the previous update entries should +be updated appropriately. This is meant to make the situation more transparent +to users reading update entries and to ensure that the process is handled +efficiently even if the package manager does not implement updates in a robust +way. This involves the following steps: + + + + +The previous package moves for the package in question must be updated +to reference the final name. That is, rather than the chain A → B → C, +we want to have two update entries: A → C, and B → C. + + + +If the package is being moved to a name that it used before, the original +move entry must be removed. That is, rather than the chain A → B → A, +we want to have the reverse entry: B → A. If the package manager did not +move A → B before, we don't want it to touch the package at all. + + + +As a combination of the two aforementioned steps, a chain of A → B → C → A +would be replaced by two moves: B → A, and C → A. + + + +If the package was slot-moved before, the slot moves should be updated +to use the final package name, and moved after the final package move. +That is, rather than the chain: A:S1 → A:S2, A → B; +we prefer to have the chain: A → B, B:S1 → B:S2. +All package and slot move entries must reside in the same file then, to +guarantee sequential processing. + + +
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/, /
commit: bd474970728035c6286f1071162efefd6f8d63e9 Author: Ulrich Müller gentoo org> AuthorDate: Thu Feb 8 10:29:50 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Feb 8 10:29:50 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bd474970 devbook.xsl: Add sub and sup elements These were present in GuideXML: https://gitweb.gentoo.org/proj/devmanual.git/tree/appendices/contributing/devbook-guide/text.xml?id=8be0d382fb82dc4cfe73b1b85bb7fc3c923a21c7#n397 Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 7 ++- devbook.rnc | 6 -- devbook.rng | 14 +- devbook.xsl | 8 4 files changed, 31 insertions(+), 4 deletions(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 5015f0b..8301b0a 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -465,7 +465,7 @@ together: Inline elements -, , and + , , , and @@ -495,6 +495,11 @@ offset from the regular paragraph type for emphasis. This helps to give your prose more punch! + +The and elements are used to specify +subscript and superscript. + + diff --git a/devbook.rnc b/devbook.rnc index 158f372..22f7c09 100644 --- a/devbook.rnc +++ b/devbook.rnc @@ -1,4 +1,4 @@ -# Copyright 2022-2023 Gentoo Authors +# Copyright 2022-2024 Gentoo Authors # Distributed under the terms of the MIT license # or the CC-BY-SA-4.0 license (dual-licensed) @@ -7,7 +7,7 @@ block.class = p | pre | codesample | note | important | warning | todo | figure | table | ul | ol | dl -attrib.class = text | b | c | e +attrib.class = text | b | c | e | sub | sup inline.class = attrib.class | d | uri attrib = attrib.class* @@ -112,6 +112,8 @@ dd = element dd { all } b = element b { inline } c = element c { inline } e = element e { inline } +sub = element sub { inline } +sup = element sup { inline } d = element d { empty } uri = element uri { diff --git a/devbook.rng b/devbook.rng index c3c616f..3963ab1 100644 --- a/devbook.rng +++ b/devbook.rng @@ -2,7 +2,7 @@ http://relaxng.org/ns/structure/1.0"; datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes";> @@ -32,6 +32,8 @@ + + @@ -382,6 +384,16 @@ + + + + + + + + + + diff --git a/devbook.xsl b/devbook.xsl index 71a74dd..6f2e4e9 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -280,6 +280,14 @@ + + + + + + + + abcdefghijklmnopqrstuvwxyz-
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: 89b2bf7f24c04546bc9d25177ee7739f528f872c Author: Michał Górny gentoo org> AuthorDate: Sun Jan 21 14:41:51 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Feb 8 10:37:26 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=89b2bf7f package-moves: Allow moving back, and describe how to chain updates Make the rule forbidding reusing old package names less strict. There is no real reason not to move packages back — we can safely assume that the package manager will handle that just fine. The only real restriction is that no other package must reuse any of the old names, i.e. effectively cause the package manager to attempt merging the packages together. Add explicit rules for updating old package move entries. These match the logic used in pkgcheck, and therefore ensure both correct results and no warnings from pkgcheck. Signed-off-by: Michał Górny gentoo.org> [Replace Unicode subscripts by markup; rewrap paragraph] Signed-off-by: Ulrich Müller gentoo.org> ebuild-maintenance/package-moves/text.xml | 56 --- 1 file changed, 51 insertions(+), 5 deletions(-) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index eab8848..33646f5 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -19,8 +19,10 @@ the following must be noted: Once an update entry is created, the old package name (or slot) cannot be -reused. Attempting to reuse it will cause updates to apply again, -to the reused name. This also means that updates cannot be undone. +reused for another package. Attempting to reuse it will cause updates to +apply again, to the reused name. This also means that while a package can +be moved back to its previous name, all the names historically used for +a package are reserved to it alone. Updates can only perform one-to-one moves. They cannot be used to merge @@ -97,9 +99,9 @@ during the update. -The process for changing the ebuild's SLOT (a "slotmove") is very similar to the -previous process. Besides changing the SLOT in the ebuild file, you -also need to create a new entry in profiles/updates/ in +The process for changing the ebuild's SLOT (a "slotmove") is very +similar to the previous process. Besides changing the SLOT in the ebuild +file, you also need to create a new entry in profiles/updates/ in the Gentoo repository in the following format: @@ -113,6 +115,50 @@ you have updated every file in profiles/ directory that happens to contain an entry which may be affected by your change. + + + + +Updating prior update entries when moving the package again + + + +When the same package is moved again, the previous update entries should +be updated appropriately. This is meant to make the situation more transparent +to users reading update entries and to ensure that the process is handled +efficiently even if the package manager does not implement updates in a robust +way. This involves the following steps: + + + + +The previous package moves for the package in question must be updated +to reference the final name. That is, rather than the chain A → B → C, +we want to have two update entries: A → C, and B → C. + + + +If the package is being moved to a name that it used before, the original +move entry must be removed. That is, rather than the chain A → B → A, +we want to have the reverse entry: B → A. If the package manager did not +move A → B before, we don't want it to touch the package at all. + + + +As a combination of the two aforementioned steps, a chain of A → B → C → A +would be replaced by two moves: B → A, and C → A. + + + +If the package was slot-moved before, the slot moves should be updated +to use the final package name, and moved after the final package move. +That is, rather than the chain: A:S1 → A:S2, A → B; +we prefer to have the chain: A → B, B:S1 → B:S2. +All package and slot move entries must reside in the same file then, to +guarantee sequential processing. + + +
[gentoo-commits] proj/devmanual:master commit in: /
commit: 2946a248b51498850ee7e672c13eaa85b7574eb3
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Jan 28 17:37:56 2024 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Jan 28 17:37:56 2024 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2946a248
Makefile: Drop obsolete test for xmllint --quiet
Signed-off-by: Ulrich Müller gentoo.org>
Makefile | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
index e75cbf1..1bfa86e 100644
--- a/Makefile
+++ b/Makefile
@@ -87,10 +87,8 @@ install: all
install -m 644 $(JS_FILES) "$(DESTDIR)$(htmldir)"/; \
fi
-# Not all versions of xmllint support --quiet, so test for it first
validate: devbook.rng
- @opt=--quiet; xmllint --help 2>&1 | grep -q -- --quiet || opt=; \
- xmllint --noout $${opt} --relaxng $< $(XMLS)
+ @xmllint --noout --quiet --relaxng $< $(XMLS)
@echo "xmllint validation successful"
%.rng: %.rnc
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: e3e5476cab5c6a5a54032b621ef58059d4371c73 Author: Ulrich Müller gentoo org> AuthorDate: Sun Jan 14 19:24:57 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jan 14 19:24:57 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e3e5476c eclass-writing: @USAGE is not required Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 2504c8c..23c7219 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -428,7 +428,7 @@ documentation are: @USAGE: - Yes + No List of required and optional arguments to the function List of arguments that the eclass function accepts, specified in
[gentoo-commits] proj/devmanual:master commit in: bin/, /
commit: 17f7b12e1a025ce0d0307156c8a3aaa087364868 Author: Ulrich Müller gentoo org> AuthorDate: Fri Jan 19 21:05:55 2024 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Jan 19 21:05:55 2024 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=17f7b12e Update copyright years Signed-off-by: Ulrich Müller gentoo.org> bin/gen-eclass-html.sh | 2 +- devbook.xsl| 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index 142c702..2d40cb6 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -80,7 +80,7 @@ IFS='' read -r -d '' FOOTER << 'EOF' -Copyright (C) 2001-2023 Gentoo Authors +Copyright (C) 2001-2024 Gentoo Authors Gentoo is a trademark of the Gentoo Foundation, Inc. The text of this document is distributed under the https://www.gnu.org/licenses/gpl-2.0.html";>GNU General Public License, version 2. diff --git a/devbook.xsl b/devbook.xsl index 322e267..71a74dd 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -708,7 +708,7 @@ - Copyright (C) 2001-2023 Gentoo Authors + Copyright (C) 2001-2024 Gentoo Authors Gentoo is a trademark of the Gentoo Foundation, Inc. The text of this document is distributed under the
[gentoo-commits] proj/devmanual:master commit in: general-concepts/licenses/
commit: bf32e5008694b6fddf4708ff22555a656972ff6e Author: Ulrich Müller gentoo org> AuthorDate: Mon Nov 20 20:04:43 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Nov 25 09:29:59 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bf32e500 general-concepts/licenses: The main license should be listed first Signed-off-by: Ulrich Müller gentoo.org> general-concepts/licenses/text.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/general-concepts/licenses/text.xml b/general-concepts/licenses/text.xml index 1e6b918..a9fb702 100644 --- a/general-concepts/licenses/text.xml +++ b/general-concepts/licenses/text.xml @@ -14,7 +14,8 @@ match files existing in the repository's licenses/ directory. The value of this variable should include all licenses pertaining to the "corresponding source" of the files installed by the package. This includes all their source code, but also all scripts used to control compilation and -installation. +installation. If the package has a "main license" i.e. a license covering +most of its files then this should be listed first.
[gentoo-commits] proj/devmanual:master commit in: /
commit: 4282d691001af8b08765a71f50ddb7e32a93f8a4 Author: Ulrich Müller gentoo org> AuthorDate: Thu Nov 23 17:20:50 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Nov 23 17:20:50 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4282d691 devbook.xsl: Use same test for eclass pages everywhere Drop relative_path_depth variable which is no longer used. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index b50ecc5..322e267 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -510,11 +510,10 @@ - - + ../ @@ -715,7 +714,8 @@ The text of this document is distributed under the - + https://www.gnu.org/licenses/gpl-2.0.html";>GNU General Public License, version 2.
[gentoo-commits] proj/devmanual:master commit in: xsl/
commit: 2c608b94d37db7706096864c67ed34772724ffc8 Author: Ulrich Müller gentoo org> AuthorDate: Sat Nov 4 20:43:34 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Nov 6 18:08:43 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2c608b94 lang.highlight.ebuild.xsl: Collect shell commands in a variable Rewrap some long lines. Signed-off-by: Ulrich Müller gentoo.org> xsl/lang.highlight.ebuild.xsl | 20 +++- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/xsl/lang.highlight.ebuild.xsl b/xsl/lang.highlight.ebuild.xsl index 4dff8d1..30ccc08 100644 --- a/xsl/lang.highlight.ebuild.xsl +++ b/xsl/lang.highlight.ebuild.xsl @@ -11,6 +11,11 @@ } # + +; if then fi -ge -lt -le -gt elif else eval unset sed rm cat [[ ]] while do read done make echo cd local return for +case esac in -n [ ] -z -f <<- > EOF + + assert best_version debug-print debug-print-function debug-print-section die diropts dobin docinto doconfd dodir @@ -184,14 +189,9 @@ - + - + @@ -221,7 +221,8 @@ - + @@ -232,7 +233,8 @@ -
[gentoo-commits] proj/devmanual:master commit in: xsl/
commit: 7393d9b055bf655e0c1b12067de0d18537786ed3 Author: Ulrich Müller gentoo org> AuthorDate: Sat Nov 4 18:44:31 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Nov 6 18:08:43 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7393d9b0 lang.highlight.ebuild.xsl: Update keyword lists Update list of package manager commands up to EAPI 8. Include eclasses that are: - used in an existing example in the Devmanual, or - general purpose eclasses and inherited by more than 1000 ebuilds in the Gentoo repository. The lists of commands are taken from ebuild-mode. Closes: https://bugs.gentoo.org/916628 Signed-off-by: Ulrich Müller gentoo.org> xsl/lang.highlight.ebuild.xsl | 337 +++--- 1 file changed, 89 insertions(+), 248 deletions(-) diff --git a/xsl/lang.highlight.ebuild.xsl b/xsl/lang.highlight.ebuild.xsl index 5a931e0..4dff8d1 100644 --- a/xsl/lang.highlight.ebuild.xsl +++ b/xsl/lang.highlight.ebuild.xsl @@ -11,6 +11,91 @@ } # + + +assert best_version debug-print debug-print-function debug-print-section die diropts dobin docinto doconfd dodir +dodoc doenvd doexe doinfo doinitd doins dolib.a dolib.so doman domo dosbin dosym ebegin econf eend eerror einfo +einfon elog emake ewarn exeinto exeopts EXPORT_FUNCTIONS fowners fperms has has_version inherit insinto insopts into +keepdir newbin newconfd newdoc newenvd newexe newinitd newins newlib.a newlib.so newman newsbin unpack use usev +use_enable use_with + +docompress nonfatal + +doheader newheader usex + +eapply eapply_user einstalldocs get_libdir in_iuse + +dostrip eqawarn ver_cut ver_rs ver_test + + +adddeny addpredict addread addwrite + +pkg_pretend pkg_setup pkg_preinst pkg_postinst pkg_prerm pkg_postrm pkg_config pkg_info pkg_nofetch src_unpack +src_prepare src_configure src_compile src_test src_install + +default default_pkg_nofetch default_src_unpack default_src_prepare default_src_configure default_src_compile +default_src_test default_src_install + + + + +autotools_check_macro autotools_m4dir_include autotools_m4sysdir_include config_rpath_update eaclocal +eaclocal_amflags eautoconf eautoheader eautomake eautopoint eautoreconf + +bashcomp_alias dobashcomp get_bashcompdir newbashcomp + +cmake_build cmake_comment_add_subdirectory cmake_run_in cmake_src_compile cmake_src_configure cmake_src_install +cmake_src_prepare cmake_src_test cmake_use_find_package + +doicon domenu make_desktop_entry make_session_desktop newicon newmenu + +epatch + +all-flag-vars append-atomic-flags append-cflags append-cppflags append-cxxflags append-fflags append-flags +append-ldflags append-lfs-flags append-libs filter-flags filter-ldflags filter-lfs-flags filter-lto filter-mfpmath +get-flag is-flag is-flagq is-ldflag is-ldflagq no-as-needed raw-ldflags replace-cpu-flags replace-flags +replace-sparc64-flags strip-flags strip-unsupported-flags test-compile test-flag-CC test-flag-CCLD test-flag-CXX +test-flag-F77 test-flag-FC test-flags test-flags-CC test-flags-CCLD test-flags-CXX test-flags-F77 test-flags-FC +test_version_info + +git-r3_checkout git-r3_fetch git-r3_peek_remote_ref git-r3_pkg_needrebuild git-r3_src_fetch git-r3_src_unpack +pkg_needrebuild + +meson_feature meson_install meson_src_compile meson_src_configure meson_src_install meson_src_test meson_use + +get_abi_CFLAGS get_abi_CHOST get_abi_CTARGET get_abi_FAKE_TARGETS get_abi_LDFLAGS get_abi_LIBDIR get_all_abis +get_all_libdirs get_exeext get_install_abis get_libname get_modname has_multilib_profile is_final_abi multilib_env +multilib_toolchain_setup number_abis + +eninja get_NINJAOPTS + +readme.gentoo_create_doc readme.gentoo_print_elog + +rpm_spec_epatch rpm_src_unpack rpm_unpack srcrpm_unpack + +clang-fullversion clang-major-version clang-micro-version clang-minor-version clang-version econf_build +gcc-fullversion gcc-major-version gcc-micro-version gcc-minor-version gcc-specs-directive gcc-specs-nostrict +gcc-specs-now gcc-specs-pie gcc-specs-relro gcc-specs-ssp gcc-specs-ssp-to-all gcc-specs-stack-check gcc-version +gen_usr_ldscript tc-arch tc-arch-kernel tc-check-openmp tc-cpp-is-true tc-detect-is-softfloat +tc-enables-cxx-assertions tc-enables-fortify-source tc-enables-pie tc-enables-ssp tc-enables-ssp-all +tc-enables-ssp-strong tc-endian tc-env_build tc-export tc-export_build_env tc-get-c-rtlib tc-get-compiler-type +tc-get-cxx-stdlib tc-getAR tc-getAS tc-getBUILD_AR tc-getBUILD_AS tc-getBUILD_CC tc-getBUILD_CPP tc-getBUILD_CXX +tc-getBUILD_LD tc-getBUILD_NM tc-getBUILD_OBJCOPY tc-getBUILD_PKG_CONFIG tc-getBUILD_PROG tc-getBUILD_RANLIB +tc-getBUILD_READELF tc-getBUILD_STRINGS tc-getBUILD_STRIP tc-getCC tc-ge
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
commit: ecc2c5953a5523ab3f4d9709066042c124bf40fc Author: Ulrich Müller gentoo org> AuthorDate: Sat Apr 16 07:16:43 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Nov 5 16:47:49 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ecc2c595 devbook-guide: Document the todo element Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 29 - 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 484a230..5015f0b 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -178,6 +178,11 @@ This is important.This is a warning. + ++Text inside a @@ -212,6 +217,11 @@ This is important. This is a warning. + +Text inside a todo element will appear in the +. + + @@ -224,15 +234,16 @@ This is a warning. We introduced a lot of new tags in the previous section here's what you need to know. Thetodo element will appear in the +. + (paragraph),
(preformatted block),(code block), - , and tags -all can contain one or more lines of text. Besides the , -,
,
-and
elements (which we'll cover in just a bit), these are the -only tags that should appear immediately inside a element. -Another thing these tags should not be stacked in other words, -don't put a
element inside a element. As -you might guess, the
andelements -preserve their whitespace exactly, making them well-suited for code excerpts: + , , and + tags all can contain one or more lines of text. +Besides the ,,
, +
and
elements (which we'll cover in just +a bit), these are the only tags that should appear immediately inside a + element. Another thing these tags should not +be stacked in other words, don't put a
element inside +a element. As you might guess, the
and +elements preserve their whitespace exactly, making +them well-suited for code excerpts:
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
commit: 6a866ee284aa6f23d57ace74f9fca05a427de4fd Author: Ulrich Müller gentoo org> AuthorDate: Thu Nov 2 17:27:20 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Nov 5 16:44:11 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6a866ee2 devbook-guide: Don't require blank lines in list items and table cells Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 7c12d6d..484a230 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -578,6 +578,8 @@ Both sections are described next., ,,
,
,
,
, and (opening tags only). +An exception to this rule applies to tags that are located within list items +or table cells.
[gentoo-commits] proj/devmanual:master commit in: /
commit: bbe65af778d3201e21f0129b0864008164578e99 Author: Ulrich Müller gentoo org> AuthorDate: Thu Nov 2 17:14:38 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Nov 5 16:43:32 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bbe65af7 devbook.xsl: Manipulate paths in getLastNode consistently Directory paths are used everywhere else, so append text.xml only when actually accessing the file. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 626b97d..b50ecc5 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -809,12 +809,12 @@ - + - + @@ -854,15 +854,15 @@ - + - + - +
[gentoo-commits] proj/devmanual:master commit in: /
commit: bc2e4a7c7f83310ff46f1cf489fea0249ef63137 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 30 17:45:02 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Nov 2 17:03:11 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bc2e4a7c depend.xsl: Canonicalise output paths Convert to absolute paths in XSLT, so postprocessing with sed is no longer needed. Signed-off-by: Ulrich Müller gentoo.org> Makefile | 2 +- depend.xsl | 23 +++ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index 89874ae..e75cbf1 100644 --- a/Makefile +++ b/Makefile @@ -74,7 +74,7 @@ appendices/todo-list/index.html: $(XMLS) # Generate the list of dependencies with XSLT, which appears to be a # better tool for this than make. .depend: $(XMLS) eclass-reference/text.xml depend.xsl devbook.xsl - @xsltproc depend.xsl $(XMLS) | sed ':x;s%[^ /]*/\.\./%%;tx' > $@ + @xsltproc depend.xsl $(XMLS) > $@ install: all set -e; \ diff --git a/depend.xsl b/depend.xsl index abb139a..15c5e15 100644 --- a/depend.xsl +++ b/depend.xsl @@ -1,8 +1,9 @@ http://exslt.org/strings"; xmlns:exslt="http://exslt.org/common"; - extension-element-prefixes="exslt xsl" - exclude-result-prefixes="exslt xsl"> + extension-element-prefixes="str exslt xsl" + exclude-result-prefixes="str exslt xsl"> @@ -20,12 +21,18 @@ - - + + + + + + + + + + +text.xml
[gentoo-commits] proj/devmanual:master commit in: /
commit: bcca132de057cf520806200b1bcb925b955b0966 Author: Ulrich Müller gentoo org> AuthorDate: Tue Oct 31 20:24:06 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Nov 2 17:04:12 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bcca132d devbook.xsl: Fix links created by contentsTree extraction If the element that is extracted from the external document contains internal references, these links would be relative to the wrong start location, namely the one defined in that document. Therefore, define our own copy of /guide/@self (pointing to the location of the target document), and rebase the tree onto it. This fixes the intra-document links in appendices/todo-list/. Closes: https://bugs.gentoo.org/916523 Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 18 +++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index fe9c496..626b97d 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -431,6 +431,7 @@ + @@ -446,6 +447,7 @@ + @@ -461,6 +463,7 @@ + @@ -474,10 +477,18 @@ + + + + + + - - - + + @@ -486,6 +497,7 @@ +
[gentoo-commits] proj/devmanual:master commit in: /
commit: 0982277a5ef77bbb91a8c7ef43150c36f78a9a24 Author: Ulrich Müller gentoo org> AuthorDate: Thu Nov 2 17:03:25 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Nov 2 17:03:25 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=0982277a devbook.xsl: Use hexadecimal for character entities Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index ce617d3..fe9c496 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -269,7 +269,7 @@ - — + — @@ -587,10 +587,10 @@ - Home + Home -Index +Index
[gentoo-commits] proj/devmanual:master commit in: bin/, /, xsl/
commit: 35c9e7d3bb24d70320729df2fe207a5ea329be97 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 30 17:41:37 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Nov 2 17:03:11 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=35c9e7d3 *.xsl: XML declaration, local variables for Emacs, whitespace fixes Signed-off-by: Ulrich Müller gentoo.org> bin/gen-eclass-html.sh| 2 +- depend.xsl| 5 + xsl/lang.highlight.c.xsl | 14 ++- xsl/lang.highlight.ebuild.xsl | 277 +- xsl/lang.highlight.m4.xsl | 26 ++-- xsl/lang.highlight.make.xsl | 18 ++- xsl/lang.highlight.sgml.xsl | 16 ++- xsl/str.tokenize.function.xsl | 14 ++- 8 files changed, 207 insertions(+), 165 deletions(-) diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index d3e8480..142c702 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -168,7 +168,7 @@ find "${OUTPUTDIR}" -mindepth 1 -maxdepth 1 -mtime +1 -exec rm -R {} \; # build the index, rebuilding it each time cat << 'EOF' > "${OUTPUTDIR}"/text.xml || exit 1 - + Eclass Reference diff --git a/depend.xsl b/depend.xsl index e0ee66c..abb139a 100644 --- a/depend.xsl +++ b/depend.xsl @@ -31,3 +31,8 @@ + + + + + diff --git a/xsl/lang.highlight.c.xsl b/xsl/lang.highlight.c.xsl index 089de50..f1e5937 100644 --- a/xsl/lang.highlight.c.xsl +++ b/xsl/lang.highlight.c.xsl @@ -1,3 +1,4 @@ + http://exslt.org/strings"; xmlns:exslt="http://exslt.org/common"; @@ -46,7 +47,7 @@ - " +" @@ -66,12 +67,17 @@ - - - + + + + + + + + diff --git a/xsl/lang.highlight.ebuild.xsl b/xsl/lang.highlight.ebuild.xsl index 47d884a..5a931e0 100644 --- a/xsl/lang.highlight.ebuild.xsl +++ b/xsl/lang.highlight.ebuild.xsl @@ -1,3 +1,4 @@ + http://exslt.org/strings"; xmlns:exslt="http://exslt.org/common"; @@ -32,23 +33,23 @@ - - - - $( - - - + + + +$( + + + - - - - ($( - - - + + + +($( + + + @@ -59,7 +60,7 @@ - $ +$ @@ -75,9 +76,9 @@ - - - + + + -- @@ -106,261 +107,261 @@ $data = 'done' or $data = 'make' or $data = 'echo' or $data = 'cd' or $data = 'local' or $data = 'return' or $data = 'for' or $data = 'case' or $data = 'esac' or $data = 'in' or $data = '-n' or $data = '[' or $data = ']' or $data = '-z' or $data = '-f' or $data = '<<-' or $data = '>' or $data = 'EOF'"> - + - + $data = 'check_KV' or $data = 'keepdir' or $data = 'econf' or $data = 'die' or $data = 'einstall' or $data = 'einfo' or + $data = 'elog' or + $data = 'ewarn' or $data = 'eerror' or $data = 'diropts' or $data = 'dobin' or $data = 'docinto' or $data = 'dodoc' or + $data = 'doexe' or $data = 'dohard' or $data = 'dohtml' or $data = 'doinfo' or $data = 'doins' or $data = 'dolib' or + $data = 'dolib.a' or $data = 'dolib.so' or $data = 'doman' or $data = 'dosbin' or $data = 'dosym' or $data = 'emake' or + $data = 'exeinto' or $data = 'exeopts' or $data = 'fowners' or $data = 'fperms' or $data = 'insinto' or $data = 'insopts' or + $data = 'into' or $data = 'libopts' or $data = 'newbin' or $data = 'newexe' or $data = 'newins' or $data = 'newman' or + $data = 'newsbin' or $data = 'prepall' or $data = 'prepalldocs' or $data = 'prepallinfo' or $data = 'prepallman' or + $data = 'prepallstrip' or $data = 'has' or $data = 'unpack' or $data = 'dosed' or $data = 'into' or + $data = 'doinitd' or $data = 'doconfd' or $data = 'doenvd' or $data = 'dojar' or $data = 'domo' or $data = 'dodir' or + $data = 'ebegin' or $data = 'eend' or $data = 'newconfd' or $data = 'newdoc' or $data = 'newenvd' or $data = 'newinitd' or + $data = 'newlib.a' or $data = 'newlib.so' or $data = 'hasq' or $data = 'hasv' or $data = 'useq' or $data = 'usev'"> + - + - + - + - + - + - + $data = 'src_in
[gentoo-commits] proj/devmanual:master commit in: /
commit: a1d3905fbbdae968ec4e99ede58a9d24f7e79c2e Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 30 16:18:01 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Oct 31 20:01:56 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a1d3905f devbook.xsl: Replace str:repeatString by a non-recursive version Also rename the template to repeat-string, i.e. move it out of the str namespace. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 32 ++-- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 668fa01..ce617d3 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -290,12 +290,18 @@ + + + + + + - + ../ @@ -418,7 +424,7 @@ - + ../ @@ -495,7 +501,7 @@ - + ../ @@ -721,24 +727,6 @@ - - - - - - - - - - - - - - - - - - @@ -884,7 +872,7 @@ - + ../
[gentoo-commits] proj/devmanual:master commit in: general-concepts/projects/, ebuild-writing/variables/, ...
commit: 2556659c7a76dd00176efd7892e02ca0130998e2 Author: Ulrich Müller gentoo org> AuthorDate: Fri Oct 27 10:22:01 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 30 16:21:14 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2556659c Fix internal links Signed-off-by: Ulrich Müller gentoo.org> appendices/common-problems/text.xml| 4 +-- appendices/contributors/text.xml | 26 - archs/alpha/text.xml | 2 +- archs/sparc/text.xml | 6 ++-- ebuild-maintenance/git/text.xml| 2 +- ebuild-maintenance/package-moves/text.xml | 2 +- ebuild-maintenance/removal/text.xml| 2 +- ebuild-writing/common-mistakes/text.xml| 2 +- ebuild-writing/error-handling/text.xml | 2 +- ebuild-writing/file-format/text.xml| 13 + ebuild-writing/functions/pkg_nofetch/text.xml | 4 +-- ebuild-writing/functions/pkg_preinst/text.xml | 6 ++-- .../src_compile/build-environment/text.xml | 2 +- ebuild-writing/functions/src_install/text.xml | 2 +- .../functions/src_prepare/epatch/text.xml | 2 +- ebuild-writing/functions/text.xml | 13 + ebuild-writing/misc-files/metadata/text.xml| 5 ++-- ebuild-writing/user-submitted/text.xml | 2 +- ebuild-writing/using-eclasses/text.xml | 8 ++--- ebuild-writing/variables/text.xml | 34 +++--- eclass-writing/text.xml| 5 ++-- function-reference/message-functions/text.xml | 2 +- function-reference/query-functions/text.xml| 5 ++-- function-reference/sandbox-functions/text.xml | 7 +++-- general-concepts/autotools/text.xml| 13 + general-concepts/dependencies/text.xml | 6 ++-- general-concepts/ebuild-revisions/text.xml | 8 ++--- general-concepts/mirrors/text.xml | 7 +++-- general-concepts/projects/text.xml | 2 +- general-concepts/slotting/text.xml | 4 +-- general-concepts/tree/text.xml | 2 +- profiles/use.desc/text.xml | 4 +-- quickstart/text.xml| 34 -- tools-reference/diff-and-patch/text.xml| 4 +-- 34 files changed, 124 insertions(+), 118 deletions(-) diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml index 1c45179..87c21bb 100644 --- a/appendices/common-problems/text.xml +++ b/appendices/common-problems/text.xml @@ -100,8 +100,8 @@ for security reasons. If this message is shown, you have a couple of options: linking. This solution is preferred. -Use append-ldflags (see ) +Use append-ldflags (see +) to add -Wl,-z,now. This will affect all binaries installed, not just the setXid ones. diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index aa101f5..06a6e0c 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -16,38 +16,38 @@ This page lists the contributions to the Gentoo Development Guide: - + - + - , + , - + - , + , - + - + - + - + Previous maintainer (XSL Stylesheets, legacy Developer Handbook content) @@ -56,9 +56,9 @@ This page lists the contributions to the Gentoo Development Guide: XSL Stylesheets, previous maintainer -, -, -, +, +, +, Misc @@ -71,7 +71,7 @@ Misc DTD, XSL stylesheet, eclass conversion - + Misc diff --git a/archs/alpha/text.xml b/archs/alpha/text.xml index 9a89adc..32b539b 100644 --- a/archs/alpha/text.xml +++ b/archs/alpha/text.xml @@ -87,7 +87,7 @@ which the compiler was built. The -mieee flag should always be used unless you have a deep knowledge of the Alpha architecture, so the comments on - are + are really important on Alpha. diff --git a/archs/sparc/text.xml b/archs/sparc/text.xml index b2a83fb..5cfbdf2 100644 --- a/archs/sparc/text.xml +++ b/archs/sparc/text.xml @@ -55,8 +55,8 @@ buses. This section is in addition to the guidelines in -. It discusses additional -requirements for the SPARC architecture. +. It discusses +additional requirements for the SPARC architecture. @@ -116,7 +116,7 @@ code. Depending upon the application, this can be anywhere up to five times slower than v9 code when running on an UltraSparc cryptographic and graphics applications which make heavy use of integer multiplication and division are especially badly hit. For this reason, the comments in - + are especially important on SPARC. diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml index 8cdabde..8bef553 1006
[gentoo-commits] proj/devmanual:master commit in: /
commit: 75aab18b528a3b76355da6fc6b36e4c6635375b8 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 30 16:13:38 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Oct 31 20:01:56 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=75aab18b devbook.xsl: Update the findNext template for relative links Create relative links with correct depth. Some other simplifications. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 32 +--- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 8d4e1df..668fa01 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -774,28 +774,16 @@ - - - - - - - - - - - - - ../ + + + + + - + - + @@ -803,11 +791,9 @@ - - - + +
[gentoo-commits] proj/devmanual:master commit in: /
commit: f2344f0b4e71e4b8c4aded22f47716bdeec35d0c Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 28 20:49:00 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 30 16:18:22 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f2344f0b devbook.xsl: Drop unused class parameter from uri template Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 13 ++--- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 1d101c1..8e4f3ec 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -311,7 +311,6 @@ - @@ -343,7 +342,7 @@ - + @@ -353,7 +352,7 @@ - + @@ -365,7 +364,7 @@ - + @@ -386,15 +385,15 @@ - + - + Error: No link target () - +
[gentoo-commits] proj/devmanual:master commit in: /
commit: 2334b4afc798d104d80fc51a66997c94d83e779e Author: Ulrich Müller gentoo org> AuthorDate: Fri Oct 27 10:19:42 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 30 16:21:14 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2334b4af devbook.xsl: Warn about missing terminating slash in internal links Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 5 - 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/devbook.xsl b/devbook.xsl index 8e4f3ec..8d4e1df 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -326,7 +326,10 @@ -/ + + Warning: No terminating slash in link () + / +
[gentoo-commits] proj/devmanual:master commit in: /
commit: cfb9ec62837857402c691a7c3ff096a9bb89dbbb Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 28 09:38:42 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 30 16:18:22 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=cfb9ec62 devbook.xsl: Rewrite the uri template Create relative links with correct depth. Assign some variables, instead of computing things multiple times. Simplify. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 132 1 file changed, 71 insertions(+), 61 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index f4ecc3e..1d101c1 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -290,30 +290,60 @@ + + + + + + + +../ + + + + + + + + + + + + + - - - - - - ../ + + + + + + + + + + + + +/ + + + + + + + + + + + - -/ - - + @@ -323,62 +353,42 @@ - -/ - - - - + + + - - - - + + - - - + + + - -/ - - - - + + + - - - - - - - - - - - - - - + + + + + + + + + + + +
[gentoo-commits] proj/devmanual:master commit in: general-concepts/mirrors/, general-concepts/manifest/
commit: dbc3fda4b0ca7be794e0aeea1ca3c775313cf86f Author: Sam James gentoo org> AuthorDate: Thu Oct 26 23:35:47 2023 + Commit: Sam James gentoo org> CommitDate: Sun Oct 29 20:22:51 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dbc3fda4 general-concepts: discuss concerns with regenerating existing distfile entries In a discussion with Eli Schwartz, I realised the devmanual doesn't currently explicitly state best practice. In general-concepts/mirrors, link to the new Manifest regeneration section and shift some text around into that new section too (and adjust the text slightly while at it). Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/318 Signed-off-by: Sam James gentoo.org> general-concepts/manifest/text.xml | 36 general-concepts/mirrors/text.xml | 9 ++--- 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/general-concepts/manifest/text.xml b/general-concepts/manifest/text.xml index 19ea5c3..bee1651 100644 --- a/general-concepts/manifest/text.xml +++ b/general-concepts/manifest/text.xml @@ -39,6 +39,42 @@ action from developers. + + +Updating Manifest files + + + +Updating existing entries within a manifest must be done with care. Upstream +changing the tarball in-place without a new filename could be an innocent +respin of the tarball, or it could indicate either the previous or the new +tarball is malicious. + + + +Developers should diff the old and new versions of the distfile, comparing +the two, and note the differences in the commit message updating the +Manifest to indicate both what happened (if any context is known) and +also what differences between the two distfiles have been ascertained. + + + +Please note that if upstream made any changes affecting the built +package or it had substantial differences, you need to also bump the ebuild's +revision. Finally, remember to remove the ebuilds that are associated with the +old distfile, or regenerate their checksums in Manifest, if there +are any. This is necessary because these ebuilds will cause checksum +mismatch errors as the checksum recorded in the manifest file no +longer matches the computed checksum of the fetched distfile. + + + +Special care is also required with regard to + +mirrors. + + + diff --git a/general-concepts/mirrors/text.xml b/general-concepts/mirrors/text.xml index 6b4993e..f1ce1bb 100644 --- a/general-concepts/mirrors/text.xml +++ b/general-concepts/mirrors/text.xml @@ -68,13 +68,8 @@ fetch and start distributing the new version. -Please note that if upstream made any changes affecting the built -package, you need to also bump the ebuild's revision. Finally, -remember to remove the ebuilds that are associated with the old -distfile, or regenerate their checksums in Manifest, if there -are any. This is necessary because these ebuilds will cause checksum -mismatch errors as the checksum recorded in the Manifest file no -longer matches the computed checksum of the fetched distfile. +Updating an existing distfile is generally cause for concern and must be done +with care, see .
[gentoo-commits] proj/devmanual:master commit in: /, general-concepts/copyright-policy/
commit: bbba1f2dc618c7d937a62474c755e1cd834d4808 Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 21 12:03:53 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 22 11:35:52 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bbba1f2d general-concepts/copyright-policy: Reformat the General guideline section Use nested ordered lists instead of one description list. Hopefully, this will make the logic better understandable. Add a diagram with a flowchart. Also commit the SVG output, so we don't need Graphviz as build dependency for a single file that isn't expected to change very often. Signed-off-by: Ulrich Müller gentoo.org> Makefile | 3 + general-concepts/copyright-policy/diagram.dot | 43 ++ general-concepts/copyright-policy/diagram.svg | 107 general-concepts/copyright-policy/text.xml| 113 -- 4 files changed, 224 insertions(+), 42 deletions(-) diff --git a/Makefile b/Makefile index 054b720..89874ae 100644 --- a/Makefile +++ b/Makefile @@ -43,6 +43,9 @@ build: $(HTMLS) $(IMAGES) documents.js: bin/build_search_documents.py $(XMLS) @python3 bin/build_search_documents.py $(XMLS) > $@ && echo "$@ built" +%.svg : %.dot + dot -T svg -o $@ $< + %.png : %.svg rsvg-convert --output=$@ $< diff --git a/general-concepts/copyright-policy/diagram.dot b/general-concepts/copyright-policy/diagram.dot new file mode 100644 index 000..5b29ab7 --- /dev/null +++ b/general-concepts/copyright-policy/diagram.dot @@ -0,0 +1,43 @@ +// Copyright 2023 Gentoo Authors +// Distributed under the terms of the CC-BY-SA-4.0 license + +digraph g { + size = "8!,2"; + node [ penwidth = 2; fontname = "Open Sans" ]; + edge [ penwidth = 2; fontname = "Open Sans" ]; + + start [ width = 1.4; height = 0.9; label = "Start" ]; + + signoff [ shape = diamond; width = 2.4; height = 1.3; +style = filled; fillcolor = "cyan"; +label = "Signed-off-by?" ]; + size[ shape = diamond; width = 2.4; height = 1.3; +style = filled; fillcolor = "cyan"; +label = "Tiny\ncontribution?" ]; + license [ shape = diamond; width = 2.4; height = 1.3; +style = filled; fillcolor = "cyan"; +label = "Contains\nlicense notice?" ]; + + accept4 [ shape = rect; width = 1.6; height = 0.8; +style = filled; fillcolor = "lime"; +label = "Accept\n(GCO point 4)" ]; + accept2 [ shape = rect; width = 1.6; height = 0.8; +style = filled; fillcolor = "lime"; +label = "Accept\n(GCO point 2)" ]; + reject [ shape = rect; width = 1.6; height = 0.7; +style = filled; fillcolor = "red"; +label = "Do not accept" ]; + + start -> signoff; + + signoff:s -> accept4 [ label = " Yes " ]; + signoff -> size[ label = " No " ]; + + size:s-> accept2 [ label = " Yes " ]; + size -> license [ label = " No " ]; + + license:s -> accept2 [ label = " Yes " ]; + license -> reject [ label = " No " ]; + + { rank = same; start; signoff; size; license; reject; } +} diff --git a/general-concepts/copyright-policy/diagram.svg b/general-concepts/copyright-policy/diagram.svg new file mode 100644 index 000..3affb30 --- /dev/null +++ b/general-concepts/copyright-policy/diagram.svg @@ -0,0 +1,107 @@ + +http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd";> + + +http://www.w3.org/2000/svg"; xmlns:xlink="http://www.w3.org/1999/xlink";> + +g + + + +start + +Start + + + +signoff + +Signed-off-by? + + + +start->signoff + + + + + +size + +Tiny +contribution? + + + +signoff->size + + + No + + + +accept4 + +Accept +(GCO point 4) + + + +signoff:s->accept4 + + + Yes + + + +license + +Contains +license notice? + + + +size->license + + + No + + + +accept2 + +Accept +(GCO point 2) + + + +size:s->accept2 + + + Yes + + + +license:s->accept2 + + + Yes + + + +reject + +Do not accept + + + +license->reject + + + No + + + diff --git a/general-concepts/copyright-policy/text.xml b/general-concepts/copyright-policy/text.xml index 7b877f8..c8d6865 100644 --- a/general-concepts/copyright-policy/text.xml +++ b/general-concepts/copyright-policy/text.xml @@ -62,54 +62,83 @@ author is, or is not required. The list below serves as a general guideline. -Examples for general guideline +General guideline - - A contribution with a Signed-off-by line by its author - -Can be accepted, because the author confirmed that it is under a free -software license. The committer adds another S-o-b line and certifies the -commit under point 4 of the + + + +When can a contribution be accepted? + + + + + +When signed off by its author (i.e. with a Signed-off-by line): + + +Can be accepted, because the author has confirmed that it is under a free +software license. The committer adds another Signed-off-
[gentoo-commits] proj/devmanual:master commit in: /
commit: 5fb4841a76b2dcfc5ec0e464f6aec698eb21a5ac Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 21 16:27:05 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 22 08:53:33 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5fb4841a devbook.xsl: Support type and start attributes for ordered lists Simply copy them to the HTML output. Signed-off-by: Ulrich Müller gentoo.org> devbook.rnc | 14 +++--- devbook.rng | 13 - devbook.xsl | 7 ++- 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/devbook.rnc b/devbook.rnc index 9fe44b8..158f372 100644 --- a/devbook.rnc +++ b/devbook.rnc @@ -1,4 +1,4 @@ -# Copyright 2022 Gentoo Authors +# Copyright 2022-2023 Gentoo Authors # Distributed under the terms of the MIT license # or the CC-BY-SA-4.0 license (dual-licensed) @@ -93,8 +93,16 @@ ti = element ti { all } -ul = element ul { attribute class { "list-group" }?, li+ } -ol = element ol { li+ } +ul = element ul { + attribute class { "list-group" }?, + li+ +} + +ol = element ol { + attribute type { "1" | "A" | "a" | "I" | "i" }?, + li+ +} + li = element li { all } dl = element dl { (dt | dd)+ } diff --git a/devbook.rng b/devbook.rng index cfca2b4..c3c616f 100644 --- a/devbook.rng +++ b/devbook.rng @@ -2,7 +2,7 @@ http://relaxng.org/ns/structure/1.0"; datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes";> @@ -326,6 +326,17 @@ + + + +1 +A +a +I +i + + + diff --git a/devbook.xsl b/devbook.xsl index 9289eab..426b2fd 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -186,7 +186,12 @@ - + + + + + +
[gentoo-commits] proj/devmanual:master commit in: /
commit: 4ad0fdff94a8e51fa2be94eff28357d962c8063a Author: Ulrich Müller gentoo org> AuthorDate: Sun Oct 22 08:39:05 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 22 11:35:52 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4ad0fdff devbook.xsl: Work around a bug in tidy tidy reports spurious warnings due to a bug in version tidy-html5-5.8.0: https://github.com/htacg/tidy-html5/issues/1012 line 128 column 1 - Warning: attribute "type" not allowed for HTML5 Work around it by using "ol style" instead of "ol type". Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 12 +++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/devbook.xsl b/devbook.xsl index 426b2fd..f4ecc3e 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -188,7 +188,17 @@ - + +list-style-type: + + decimal + upper-alpha + lower-alpha + upper-roman + lower-roman + + +
[gentoo-commits] proj/devmanual:master commit in: bin/, /
commit: 2957b24ceea553281746f6b4528f757f4f5d6b54 Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 21 23:18:09 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Oct 21 23:18:09 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2957b24c devbook.xsl: Force end tag for empty li elements In order to make "tidy" happy. For some reason, xsltproc omits the end tag if the element is empty. Apparently, an empty comment is enough to make it think differently. Signed-off-by: Ulrich Müller gentoo.org> bin/gen-eclass-html.sh | 4 ++-- devbook.xsl| 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index 74e25dc..d3e8480 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -30,11 +30,11 @@ IFS='' read -r -d '' HEADER << 'EOF' https://bugs.gentoo.org/"; title="Report issues and find common issues"> Bugs https://forums.gentoo.org/"; title="Discuss with the community"> Forums https://packages.gentoo.org/"; title="Find software for your Gentoo"> Packages - + https://planet.gentoo.org/"; title="Find out what's going on in the developer community"> Planet https://archives.gentoo.org/"; title="Read up on past discussions"> Archives https://sources.gentoo.org/"; title="Browse our source code"> Sources - + https://infra-status.gentoo.org/"; title="Get updates on the services provided by Gentoo"> Infra Status diff --git a/devbook.xsl b/devbook.xsl index e06d6e0..9289eab 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -518,11 +518,11 @@ https://bugs.gentoo.org/"; title="Report issues and find common issues"> Bugs https://forums.gentoo.org/"; title="Discuss with the community"> Forums https://packages.gentoo.org/"; title="Find software for your Gentoo"> Packages - + https://planet.gentoo.org/"; title="Find out what's going on in the developer community"> Planet https://archives.gentoo.org/"; title="Read up on past discussions"> Archives https://sources.gentoo.org/"; title="Browse our source code"> Sources - + https://infra-status.gentoo.org/"; title="Get updates on the services provided by Gentoo"> Infra Status
[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/
commit: c97926baf8da7cf327509a0cd8718ca2bb9db56e Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 21 07:54:31 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Oct 21 19:05:40 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c97926ba function-reference/install-functions: Mention dosym -r option Closes: https://bugs.gentoo.org/916017 Signed-off-by: Ulrich Müller gentoo.org> function-reference/install-functions/text.xml | 15 ++- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/function-reference/install-functions/text.xml b/function-reference/install-functions/text.xml index 0602c80..0d37980 100644 --- a/function-reference/install-functions/text.xml +++ b/function-reference/install-functions/text.xml @@ -278,11 +278,16 @@ The *into functions create the directory if it does not already exist. dosym - Create a symlink to the target specified as the first parameter, - at the path specified by the second parameter. Note that - the target is interpreted verbatim; it needs to either - specify a relative path or an absolute path including - ${EPREFIX}. + + Create a symlink to the target specified as the first parameter, at the + path specified by the second parameter. With option -r (EAPI 8), + an absolute path specified for the target will be converted to a path + relative to the link location. + + + Note: Without option -r, an absolute link target is interpreted + verbatim, i.e. it must include ${EPREFIX} when applicable. +
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/new-ebuild/
commit: fd399e73274e120f5171d2f75fe0dfbe8c032b1d Author: Ulrich Müller gentoo org> AuthorDate: Sat Oct 21 11:43:54 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Oct 21 11:43:54 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd399e73 ebuild-maintenance/new-ebuild; Fix link to bugzilla advanced search Also update the paragraph explaining it. Signed-off-by: Ulrich Müller gentoo.org> ebuild-maintenance/new-ebuild/text.xml | 19 ++- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/ebuild-maintenance/new-ebuild/text.xml b/ebuild-maintenance/new-ebuild/text.xml index ea6dcab..10793e0 100644 --- a/ebuild-maintenance/new-ebuild/text.xml +++ b/ebuild-maintenance/new-ebuild/text.xml @@ -8,15 +8,16 @@ -Before writing a new ebuild, check -https://bugs.gentoo.org/";>bugs.gentoo.org -to see if an ebuild has already been written for the package, but has not yet -been added to the Gentoo repository. Go to https://bugs.gentoo.org/";>bugs.gentoo.org, choose query and select -Advanced Search; as product select Gentoo Linux, as component select -ebuilds. In the search field put the name of the ebuild and as status -select all possible fields, then submit the query. For you lazy people, click -https://bugs.gentoo.org/query.cgi?format=advanced&product=Gentoo%20Linux&component=New%20Ebuilds&bug_Status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=RESOLVED&bug_status=VERIFIED";>here. +Before writing a new ebuild, check https://bugs.gentoo.org/";> +bugs.gentoo.org to see if an ebuild has already been written for +the package, but has not yet been added to the Gentoo repository. Go to +https://bugs.gentoo.org/";>bugs.gentoo.org, choose query and +select Advanced Search; as product select Gentoo Linux, as component +select New packages. In the search field put the name of the ebuild and +as status and resolution select all possible fields, then submit the query. +For you lazy people, here is a +https://bugs.gentoo.org/query.cgi?format=advanced&product=Gentoo%20Linux&component=New%20packages";> +Bugzilla advanced search link.
[gentoo-commits] proj/devmanual:master commit in: /
commit: 1fa2d305931d6e1593ff5120c427ae05fbf7bf08 Author: Ulrich Müller gentoo org> AuthorDate: Thu Oct 5 20:42:42 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Oct 5 20:42:42 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1fa2d305 devbook.xsl: Whitespace Fixes: 19153057c1dbbc3537dfc9d1ca20a12d69a46c81 Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index d998710..e06d6e0 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -658,9 +658,9 @@ https://twitter.com/gentoo"; title="@Gentoo on Twitter"> https://www.facebook.com/gentoo.org"; title="Gentoo on Facebook"> - - https://wiki.gentoo.org/wiki/Foundation:Privacy_Policy";>Privacy Policy - + + https://wiki.gentoo.org/wiki/Foundation:Privacy_Policy";>Privacy Policy +
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
commit: acbf1e23650c3cad83ed0d39980032dcb885f7e7 Author: Ulrich Müller gentoo org> AuthorDate: Thu Oct 5 20:29:19 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Oct 5 20:29:19 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=acbf1e23 appendices/devbook-guide: GuideXML -> DevBook XML Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index f9a6b5a..7c12d6d 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -11,7 +11,7 @@ The DevBook XML syntax is lightweight yet expressive, so that it is easy to learn yet also provides all the features we need for the creation of web documentation. The number of tags is kept to a minimum just those we need. -This makes it easy to transform guide into other formats, such as DocBook +This makes it easy to transform DevBook XML into other formats, such as DocBook XML/SGML or web-ready HTML.
[gentoo-commits] proj/devmanual:master commit in: /, bin/
commit: 19153057c1dbbc3537dfc9d1ca20a12d69a46c81 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 2 10:53:27 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Oct 5 18:58:34 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=19153057 devbook.xsl, bin/gen-eclass-html.sh: Link to privacy policy Bug: https://bugs.gentoo.org/613938 Signed-off-by: Ulrich Müller gentoo.org> bin/gen-eclass-html.sh | 9 +++-- devbook.xsl| 3 +++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index 7ace03b..74e25dc 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -70,10 +70,15 @@ IFS='' read -r -d '' FOOTER << 'EOF' - + + https://twitter.com/gentoo"; title="@Gentoo on Twitter"> https://www.facebook.com/gentoo.org"; title="Gentoo on Facebook"> - + + +https://wiki.gentoo.org/wiki/Foundation:Privacy_Policy";>Privacy Policy + + Copyright (C) 2001-2023 Gentoo Authors Gentoo is a trademark of the Gentoo Foundation, Inc. diff --git a/devbook.xsl b/devbook.xsl index 7b6c734..d998710 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -658,6 +658,9 @@ https://twitter.com/gentoo"; title="@Gentoo on Twitter"> https://www.facebook.com/gentoo.org"; title="Gentoo on Facebook"> + + https://wiki.gentoo.org/wiki/Foundation:Privacy_Policy";>Privacy Policy +
[gentoo-commits] proj/devmanual:master commit in: function-reference/query-functions/
commit: 546b966a7f10773de891ab4e280e3aefe0c142c0 Author: Ulrich Müller gentoo org> AuthorDate: Sun Oct 1 17:29:06 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 1 17:29:06 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=546b966a function-reference/query-functions: usev accepts two args in EAPI 8 Closes: https://bugs.gentoo.org/914590 Signed-off-by: Ulrich Müller gentoo.org> function-reference/query-functions/text.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/function-reference/query-functions/text.xml b/function-reference/query-functions/text.xml index 9d599e8..0233e26 100644 --- a/function-reference/query-functions/text.xml +++ b/function-reference/query-functions/text.xml @@ -39,10 +39,11 @@ query variables and similar state. - usev flagname + usev flagname [true output] - As use, echoes flagname upon success. + As use, but also echoes flagname upon success. In EAPI 8 + and later, echoes the second argument instead, if it is specified.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: a970eb2d03e0856beaac41786e9e27fb7376875a Author: Petr Vaněk atlas cz> AuthorDate: Wed Sep 27 07:22:02 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Sep 27 08:29:33 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a970eb2d general-concepts/dependencies: use tag for dev-util/ebuildtester Signed-off-by: Petr Vaněk atlas.cz> Signed-off-by: Ulrich Müller gentoo.org> general-concepts/dependencies/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index aea0d7f..b041444 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -702,7 +702,7 @@ package: A sure-way to find missing dependencies is to test your ebuild in a deprived environment. Chroots, containers, virtual machines and -dev-util/ebuildtester can achieve this. +dev-util/ebuildtester can achieve this.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: 80a65cf5f16ebf75b7606fbdcdc4db5e3ea3e097 Author: Ulrich Müller gentoo org> AuthorDate: Sat Aug 19 14:01:19 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Aug 26 05:39:28 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=80a65cf5 general-concepts/ebuild-revisions: License updates may require a revbump See for example bug 912458, where removal of the unused CMake license caused a blocker on users' systems. Signed-off-by: Ulrich Müller gentoo.org> general-concepts/ebuild-revisions/text.xml | 4 1 file changed, 4 insertions(+) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index e0c8b01..b524a4b 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -74,6 +74,10 @@ of thumb could be used as a guideline: restricting a runtime dependency version, unless the := subslot operator is going to trigger a rebuild, + +updating the license, if any of the affected licenses is either non-free or +is about to be removed, + changing the EAPI (unless changes to the ebuild are trivial, and you can be sure it won't break stable or reverse dependencies).
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 84304f7b8fa1706c6aa046cb84be4fa33c46d9f8 Author: Ulrich Müller gentoo org> AuthorDate: Fri Jun 30 09:24:14 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Aug 26 05:29:02 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=84304f7b eclass-writing: Use underscores for function names in the example Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 15 --- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index ef58547..2b3033e 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -795,34 +795,35 @@ BDEPEND=">=sys-devel/jmake-2" # @DESCRIPTION: # Passes all arguments through to the appropriate "jmake configure" # command. -jmake-configure() { +jmake_configure() { jmake configure --prefix=/usr "$@" } # @FUNCTION: jmake_src_configure # @USAGE: [additional-args] # @DESCRIPTION: -# Calls jmake-configure() to configure a jmake project. Passes all +# Calls jmake_configure() to configure a jmake project. Passes all # arguments through to the appropriate "jmake configure" command. jmake_src_configure() { - jmake-configure "$@" || die "configure failed" + jmake_configure "$@" || die "configure failed" } -# @FUNCTION: jmake-build +# @FUNCTION: jmake_build # @USAGE: [additional-args] # @DESCRIPTION: # First builds all dependencies, and then passes through its arguments # to the appropriate "jmake build" command. -jmake-build() { +jmake_build() { jmake dep && jmake build "$@" } # @FUNCTION: jmake_src_compile # @DESCRIPTION: -# Calls jmake-build() to compile a jmake project. +# Calls jmake_build() to compile a jmake project. jmake_src_compile() { - jmake-build || die "build failed" + jmake_build || die "build failed" } + fi EXPORT_FUNCTIONS src_configure src_compile
[gentoo-commits] proj/devmanual:master commit in: general-concepts/use-flags/
commit: 29978d077d271058b31a4578617880013448093d Author: Jonas Frei pm me> AuthorDate: Tue Aug 22 03:17:10 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 22 06:03:16 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=29978d07 general-concepts/use-flags: Clarification about compiler flags Signed-off-by: Jonas Frei pm.me> [Whitespace fixed.] Signed-off-by: Ulrich Müller gentoo.org> general-concepts/use-flags/text.xml | 11 ++- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/general-concepts/use-flags/text.xml b/general-concepts/use-flags/text.xml index 7d0047a..5caa430 100644 --- a/general-concepts/use-flags/text.xml +++ b/general-concepts/use-flags/text.xml @@ -82,10 +82,10 @@ instead, or controlled by a flag such as minimal. -You should not introduce USE flags that merely manipulate CFLAGS, -FEATURES or similar variables configured directly by the user. Instead, -packages should avoid manipulating them at all, and let users set them directly. -Common mistakes include: +You should not introduce USE flags that manipulate compiler flags or similar +variables configured directly by the user (e.g. -O3, -flto). +Instead, packages should avoid manipulating them at all, and let users set +them directly. Common mistakes include: @@ -114,7 +114,8 @@ There might be corner cases where these rules do not apply. For example, a few upstreams require users to use specific CFLAGS and reject bug reports against builds using other values. In this case, it is customary to strip flags by default and provide custom-cflags flag to allow users to force their -preferred flags. +preferred flags. Another exception are CFLAGS that enable/disable +features at compile time (via pre-processor macros).
[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/
commit: ada952e76ffe339d2e0a7b822a4786e26bb7fdfd Author: Ulrich Müller gentoo org> AuthorDate: Sat Apr 29 15:30:28 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat May 27 18:50:34 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ada952e7 function-reference/install-functions: Reword dostrip documentation As a followup to the previous change, use a better path for the example and reword. No longer mention EAPI 7 because all older EAPIs are deprecated. Signed-off-by: Ulrich Müller gentoo.org> function-reference/install-functions/text.xml | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/function-reference/install-functions/text.xml b/function-reference/install-functions/text.xml index 6961784..0602c80 100644 --- a/function-reference/install-functions/text.xml +++ b/function-reference/install-functions/text.xml @@ -427,11 +427,11 @@ The *into functions create the directory if it does not already exist. dostrip - Introduced with EAPI=7, controls the stripping of executables. - Normally executed to exclude from stripping. - Eg. dostrip -x /path/to/important.so. May also be used to include binaries - to strip when RESTRICT=strip without the -x option. - Provided paths are relative to ${ED}, even if they begin with a slash. + Controls stripping of executables. Normally used to exclude from + stripping, e.g. dostrip -x /usr/$(get_libdir)/important.so. + May also be used without the -x option to include binaries to + strip when RESTRICT=strip is set. Provided paths are relative + to ${ED}, even if they begin with a slash.
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: fb4c29d6e107495edb942dfca69ca7d36310a2ad Author: Ulrich Müller gentoo org> AuthorDate: Sat May 27 18:49:17 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat May 27 18:49:17 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fb4c29d6 eclass-writing: Drop INCLUDES_EPREFIX documentation tag This reflects its being dropped from eclass-to-manpage. Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 23 --- 1 file changed, 23 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 7b2a3d2..ef58547 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -365,14 +365,6 @@ variables are as follows: developer - - @INCLUDES_EPREFIX - No - - -Indicates that the variable is a path which has ${EPREFIX} prepended to it - - @INTERNAL No @@ -461,15 +453,6 @@ documentation are: maintainer. Must start on a newline after the tag. - - @INCLUDES_EPREFIX - No - - -Indicates whether the function returns a path with ${EPREFIX} prepended -to it - - @INTERNAL No @@ -546,12 +529,6 @@ using the following tags: developer - - @INCLUDES_EPREFIX - No - - Indicates that the variable is a path which has ${EPREFIX} prepended - @INTERNAL No
[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/
commit: caa3e98b1431ceeead2924302bcc997d6214ba69 Author: matoro users noreply github com> AuthorDate: Thu Apr 27 19:07:06 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Apr 29 15:26:18 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=caa3e98b function-reference/install-functions: add note about paths to dostrip Found this extremely unintuitive especially compared to the documentation on the `dosym` function which is much clearer. Closes: https://bugs.gentoo.org/17 Signed-off-by: Matoro Mahri users.noreply.github.com> Signed-off-by: Ulrich Müller gentoo.org> function-reference/install-functions/text.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/function-reference/install-functions/text.xml b/function-reference/install-functions/text.xml index 9fbdcbe..6961784 100644 --- a/function-reference/install-functions/text.xml +++ b/function-reference/install-functions/text.xml @@ -431,6 +431,7 @@ The *into functions create the directory if it does not already exist. Normally executed to exclude from stripping. Eg. dostrip -x /path/to/important.so. May also be used to include binaries to strip when RESTRICT=strip without the -x option. + Provided paths are relative to ${ED}, even if they begin with a slash.
[gentoo-commits] proj/devmanual:master commit in: bin/, /
commit: 2c4c9ff6b730322167ba20fc3f537aa74185723d Author: Ulrich Müller gentoo org> AuthorDate: Sat Jan 21 17:37:25 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Jan 21 17:37:25 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2c4c9ff6 Update copyright years Signed-off-by: Ulrich Müller gentoo.org> bin/gen-eclass-html.sh | 2 +- devbook.xsl| 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index 6021c1e..7ace03b 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -75,7 +75,7 @@ IFS='' read -r -d '' FOOTER << 'EOF' https://www.facebook.com/gentoo.org"; title="Gentoo on Facebook"> -Copyright (C) 2001-2022 Gentoo Authors +Copyright (C) 2001-2023 Gentoo Authors Gentoo is a trademark of the Gentoo Foundation, Inc. The text of this document is distributed under the https://www.gnu.org/licenses/gpl-2.0.html";>GNU General Public License, version 2. diff --git a/devbook.xsl b/devbook.xsl index f5b3e72..7b6c734 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -661,7 +661,7 @@ - Copyright (C) 2001-2022 Gentoo Authors + Copyright (C) 2001-2023 Gentoo Authors Gentoo is a trademark of the Gentoo Foundation, Inc. The text of this document is distributed under the
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: f5cec0886bed97956d047c73cb997f2aa2a15b5f Author: Sam James gentoo org> AuthorDate: Fri Aug 26 04:42:02 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 14 20:04:05 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f5cec088 general-concepts/ebuild-revisions: clarify interaction with adding/removing 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 gentoo.org> general-concepts/ebuild-revisions/text.xml | 10 -- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index ad394e8..e0c8b01 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -103,8 +103,14 @@ of thumb could be used as a guideline: (unless it is also a runtime dependency), -adding a new USE flag or removing an existing one (since change -in USE flags is going to trigger --changed-use rebuild), +adding a new USE flag if it controls a USE-dependency where the +functionality was hard-disabled in the build system before, + + +removing an existing USE flag if it controls a USE-dependency where the +functionality is now disabled entirely, rather than always being enabled +(since the change in USE flags is going to trigger a --changed-use +rebuild), a trivial stylistic / ebuild code change (as long as the new code
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/
commit: 81fd4e9f4762cb08344a1b8e1bf147e816129543 Author: Joonas Niilola gentoo org> AuthorDate: Thu Jan 12 11:26:54 2023 + Commit: Joonas Niilola gentoo org> CommitDate: Thu Jan 12 11:26:54 2023 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=81fd4e9f ebuild-writing/file-format: update copyright header's year to 2023 - since some people get it from this file. Signed-off-by: Joonas Niilola gentoo.org> ebuild-writing/file-format/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml index ca41803..63b7f5e 100644 --- a/ebuild-writing/file-format/text.xml +++ b/ebuild-writing/file-format/text.xml @@ -189,7 +189,7 @@ header.txt in the top directory of the Gentoo repository. -# Copyright 1999-2021 Gentoo Authors +# Copyright 1999-2023 Gentoo Authors # Distributed under the terms of the GNU General Public License v2
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
commit: 8db9349ee61829e0f17a98619989f94238cafabb Author: Sam James gentoo org> AuthorDate: Mon Nov 21 00:02:37 2022 + Commit: Sam James gentoo org> CommitDate: Tue Nov 22 04:17:44 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8db9349e ebuild-maintenance/git: update grafted repo URL Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/306 Signed-off-by: Sam James gentoo.org> ebuild-maintenance/git/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml index 411e406..8cdabde 100644 --- a/ebuild-maintenance/git/text.xml +++ b/ebuild-maintenance/git/text.xml @@ -90,9 +90,9 @@ graft it into the repository: -git remote add history https://anongit.gentoo.org/git/repo/gentoo/historical.git/ +git remote add history https://anongit.gentoo.org/git/archive/repo/gentoo-2.git git fetch history -git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d history/master +git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d cvs-final-2015-08-08
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: 2b94b64306230dc3595150c5bba87ec0763d93a3 Author: Sam James gentoo org> AuthorDate: Tue Nov 8 04:31:16 2022 + Commit: Sam James gentoo org> CommitDate: Thu Nov 10 07:17:02 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2b94b643 general-concepts/ebuild-revisions: note which build-time fixes need a new revision Signed-off-by: Sam James gentoo.org> general-concepts/ebuild-revisions/text.xml | 6 +- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index fc5ba7c..b2fa57f 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -85,7 +85,11 @@ of thumb could be used as a guideline: adding a patch to fix a build-time issue that prevented users from building the package (since it does not affect users who already -managed to build it), +managed to build it) unless: it affected runtime behaviour in some way +(e.g. -Wformat or -Wimplicit-function-declaration fixes); +the package may have been miscompiled, or the change is substantial +(if adding a huge patch to fix a problem, the chances of an unexpected +issue being introduced by it are larger). adding a trivial documentation fix,
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: ce68316d173482f9b82fb3255b1a657c08c80c56 Author: Sam James gentoo org> AuthorDate: Tue Nov 8 04:31:33 2022 + Commit: Sam James gentoo org> CommitDate: Thu Nov 10 07:17:03 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ce68316d general-concepts/ebuild-revisions: note that build failures may be a missing 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 gentoo.org> general-concepts/ebuild-revisions/text.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index b2fa57f..ad394e8 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -89,7 +89,7 @@ of thumb could be used as a guideline: (e.g. -Wformat or -Wimplicit-function-declaration fixes); the package may have been miscompiled, or the change is substantial (if adding a huge patch to fix a problem, the chances of an unexpected -issue being introduced by it are larger). +issue being introduced by it are greater). adding a trivial documentation fix, @@ -99,7 +99,8 @@ of thumb could be used as a guideline: is expected soon), -adding a missing build-time dependency that caused a build failure, +adding a missing build-time dependency that caused a build failure +(unless it is also a runtime dependency), adding a new USE flag or removing an existing one (since change
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/
commit: 960cd5a52ec51120330ee4b099e89c58f61ee3a8 Author: Ulrich Müller gentoo org> AuthorDate: Wed Oct 19 09:13:19 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Oct 19 09:13:19 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=960cd5a5 ebuild-writing/eapi: Replace interactive by live in example The former is semi-deprecated and we shouldn't advertise its use. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/eapi/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index 45b032a..b6463c0 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -1072,7 +1072,7 @@ EAPI=7 inherit git-r3 -PROPERTIES+=" interactive" +PROPERTIES+=" live" @@ -1086,7 +1086,7 @@ EAPI=8 inherit git-r3 -PROPERTIES="interactive" +PROPERTIES="live"
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/, ebuild-maintenance/removal/
commit: 118ac514581c8992df1b19aee1663b6a7f7607c4 Author: Sam James gentoo org> AuthorDate: Thu Oct 6 13:06:23 2022 + Commit: Sam James gentoo org> CommitDate: Fri Oct 14 21:49:36 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=118ac514 ebuild-maintenance/removal: Change inconsistent virtual revbump policy 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 gentoo.org> ebuild-maintenance/removal/text.xml| 6 ++ general-concepts/ebuild-revisions/text.xml | 5 - 2 files changed, 2 insertions(+), 9 deletions(-) diff --git a/ebuild-maintenance/removal/text.xml b/ebuild-maintenance/removal/text.xml index de3a9c1..5413a06 100644 --- a/ebuild-maintenance/removal/text.xml +++ b/ebuild-maintenance/removal/text.xml @@ -113,10 +113,8 @@ In order to remove a virtual package, follow the following procedure: Wait the time appropriate for the last rites. -Update all ebuilds not to reference the virtual. Since there is -no urgent need to remove the virtual from user systems -and the resulting rebuilds would be unnecessary, do not bump ebuilds -when replacing the dependency. +Update all ebuilds not to reference the virtual, following normal + policy Remove the package directly diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index b274841..fc5ba7c 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -108,11 +108,6 @@ of thumb could be used as a guideline: a dependency change that is a result of a package move (slot move), - -a dependency change due to - -removal of a virtual package. -
[gentoo-commits] proj/devmanual:master commit in: general-concepts/filesystem/, ebuild-writing/functions/src_prepare/, ...
commit: b877f644c77f43e07adc134c72d79972e4e4fa23 Author: Ulrich Müller gentoo org> AuthorDate: Sun Oct 9 09:56:52 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 9 09:56:52 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b877f644 Explicitly specify UTF-8 encoding in XML declarations As specified by the DevBook XML guide. Signed-off-by: Ulrich Müller gentoo.org> appendices/common-problems/text.xml | 2 +- appendices/contributing/text.xml| 2 +- appendices/contributors/text.xml| 2 +- appendices/editor-configuration/emacs/text.xml | 2 +- appendices/editor-configuration/text.xml| 2 +- appendices/editor-configuration/vim/text.xml| 2 +- appendices/editor-configuration/xemacs/text.xml | 2 +- appendices/further-reading/text.xml | 2 +- appendices/text.xml | 2 +- appendices/todo-list/text.xml | 2 +- archs/alpha/text.xml| 2 +- archs/amd64/text.xml| 2 +- archs/mips/text.xml | 2 +- archs/ppc/text.xml | 2 +- archs/sparc/text.xml| 2 +- archs/text.xml | 2 +- archs/x86/text.xml | 2 +- ebuild-maintenance/git/text.xml | 2 +- ebuild-maintenance/new-ebuild/text.xml | 2 +- ebuild-maintenance/package-moves/text.xml | 2 +- ebuild-maintenance/removal/text.xml | 2 +- ebuild-maintenance/text.xml | 2 +- ebuild-writing/common-mistakes/text.xml | 2 +- ebuild-writing/eapi/text.xml| 2 +- ebuild-writing/error-handling/text.xml | 2 +- ebuild-writing/file-format/text.xml | 2 +- ebuild-writing/functions/pkg_config/text.xml| 2 +- ebuild-writing/functions/pkg_info/text.xml | 2 +- ebuild-writing/functions/pkg_nofetch/text.xml | 2 +- ebuild-writing/functions/pkg_postinst/text.xml | 2 +- ebuild-writing/functions/pkg_postrm/text.xml| 2 +- ebuild-writing/functions/pkg_preinst/text.xml | 2 +- ebuild-writing/functions/pkg_prerm/text.xml | 2 +- ebuild-writing/functions/pkg_pretend/text.xml | 2 +- ebuild-writing/functions/pkg_setup/text.xml | 2 +- ebuild-writing/functions/src_compile/build-environment/text.xml | 2 +- ebuild-writing/functions/src_compile/building/text.xml | 2 +- ebuild-writing/functions/src_compile/no-build-system/text.xml | 2 +- ebuild-writing/functions/src_compile/text.xml | 2 +- ebuild-writing/functions/src_configure/configuring/text.xml | 2 +- ebuild-writing/functions/src_configure/text.xml | 2 +- ebuild-writing/functions/src_install/docompress/text.xml| 2 +- ebuild-writing/functions/src_install/text.xml | 2 +- ebuild-writing/functions/src_prepare/autopackage/text.xml | 2 +- ebuild-writing/functions/src_prepare/epatch/text.xml| 2 +- ebuild-writing/functions/src_prepare/text.xml | 2 +- ebuild-writing/functions/src_test/text.xml | 2 +- ebuild-writing/functions/src_unpack/other-formats/text.xml | 2 +- ebuild-writing/functions/src_unpack/rpm-sources/text.xml| 2 +- ebuild-writing/functions/src_unpack/text.xml| 2 +- ebuild-writing/functions/src_unpack/vcs-sources/text.xml| 2 +- ebuild-writing/functions/text.xml | 2 +- ebuild-writing/messages/text.xml| 2 +- ebuild-writing/misc-files/metadata/text.xml | 2 +- ebuild-writing/misc-files/patches/text.xml | 2 +- ebuild-writing/misc-files/text.xml | 2 +- ebuild-writing/text.xml | 2 +- ebuild-writing/use-conditional-code/text.xml| 2 +- ebuild-writing/user-submitted/text.xml | 2 +- ebuild-writing/users-and-groups/text.xml| 2 +- ebuild-writing/using-eclasses/text.xml | 2 +- ebuild-writing/variables/text.xml | 2 +- eclass-writing/text.xml | 2 +- function-reference/build-fu
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: 65170e5755b44601f725d6c04e25ec2af3d6aba6 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 17 06:57:22 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Aug 17 06:57:22 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=65170e57 ebuild-writing/variables: Demote single variable sections to subsections Reorder subsections to follow the ordering of the tables. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/variables/text.xml | 340 +++--- 1 file changed, 170 insertions(+), 170 deletions(-) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index f07832e..4c7df4f 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -185,6 +185,57 @@ for these variables when writing ebuilds. + + +ROOT + + + +The idea behind ROOT is that one can build a system with +ROOT=/somewhere and then chroot into it or tar up +/somewhere as a system image. It is not designed to allow the +user to run /somewhere/usr/bin/foo. + + + +Ebuilds may reference ROOT only during pkg_* phases. It +can't be used correctly in src_* phases, since ROOT may +be different when merging a binary package. For example, a binary +package may be built with ROOT=/ and then installed onto a +system using ROOT=/somewhere. + + + +When building a package, ROOT should not be used to satisfy the +required dependencies on libraries, headers files etc. Instead, the +files on the build system should be specified using /. + + + +In a cross compiling environment, ebuilds must not call any of the +binaries inside ROOT since they may not be executable on the +build system. + + + +Below is an example of an ebuild that uses ROOT in +pkg_postinst() to conditionally print an error message if an +old and obsolete configuration file still exists: + + + +pkg_postinst() { + if [[ -e "${ROOT}/etc/oldconfig" ]]; then + ewarn "You still have the obsolete config file " + ewarn "${ROOT}/etc/oldconfig." + ewarn "Please migrate your settings to ${ROOT}/etc/newconfig" + ewarn "and remove ${ROOT}/etc/oldconfig." + fi +} + + + + @@ -348,45 +399,11 @@ The following variables may or must be defined by every ebuild. - - -SLOT - - - -When slots are not needed, use SLOT="0". Do not use -SLOT="", because the variable must not be empty. - - - -See for more information on this -variable and see . - - - - - - -KEYWORDS - - - -The only valid construct involving a * inside KEYWORDS is a -*. Do -not use KEYWORDS="*" or KEYWORDS="~*". - - - -See for how to handle this variable. - - - - - - + SRC_URI - + Conditional Sources @@ -405,9 +422,9 @@ SRC_URI="https://example.com/files/${P}-core.tar.bz2 - + - + Renaming Sources @@ -430,9 +447,9 @@ SRC_URI="https://example.com/files/${PV}.tar.gz -> ${P}.tar.gz" - + - + Third-party mirrors @@ -487,9 +504,9 @@ list does not outweigh the burden of maintaining it. - + - + Lifting restrictions @@ -547,110 +564,161 @@ The following table shows the effects of the prefixes when RESTRICT="mirror"< + - - -IUSE + +LICENSE -Note that the IUSE variable is cumulative, so there is no need to specify -USE flags used only within inherited eclasses within the ebuild's IUSE. - - -You need not assign the IUSE variable in your ebuild if it is empty. - - - -Arch USE flags (sparc, mips, x64-macos and so on) should -not be listed. +It is possible to specify multiple LICENSE entries, and entries which only +apply if a particular USE flag is set. The format is the same as for +DEPEND. See https://www.gentoo.org/glep/glep-0023.html";> +GLEP 23 for details. - + - -LICENSE + +SLOT -It is possible to specify multiple LICENSE entries, and entries which only -apply if a particular USE flag is set. The format is the same as for -DEPEND. See https://www.gentoo.org/glep/glep-0023.html";> -GLEP 23 for details. +When slots are not needed, use SLOT="0". Do not use +SLOT="", because the variable must not be empty. + + + +See for more information on this +variable and see . - + - -RESTRICT + +KEYWORDS -While Portage may recognise several different RESTRICT tokens, it is -important that you do not rely on them existing. That is, you should ensure -your ebuild does not fail if those tokens are not exposed or given a different -name by another package manager. You can make use of Portage-provided -RESTRICT tokens, but do not fail hard without them. See -https://projects.gentoo.org/pms/7/pms.html#x1-810008.2.8";> -PMS for the list of standardised RESTRICT tokens, or the above -table. +The only valid construct involving a * inside KEYWORDS is a -*. Do +not use KEYWORDS="*" or KEYWORDS="~*". + + + +See for how to handle this variable. - + - -ROOT + +IUSE -The idea behind ROOT is that one can build a system with -ROOT=/somewh
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: f73fcfb9352f815d44a0198516ac759caa6e09ec Author: Ulrich Müller gentoo org> AuthorDate: Thu Aug 18 07:45:05 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 25 16:41:07 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f73fcfb9 ebuild-writing/variables: Fix example for ROOT Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/variables/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index d77f4b7..03d8752 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -225,8 +225,8 @@ old and obsolete configuration file still exists: pkg_postinst() { - if [[ -e "${ROOT}/etc/oldconfig" ]]; then - ewarn "You still have the obsolete config file " + if [[ -e ${ROOT}/etc/oldconfig ]]; then + ewarn "You still have the obsolete config file" ewarn "${ROOT}/etc/oldconfig." ewarn "Please migrate your settings to ${ROOT}/etc/newconfig" ewarn "and remove ${ROOT}/etc/oldconfig."
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: 7ef569e7b5487784b5cab81daef60cd920da2082 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 17 07:08:26 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Aug 18 16:02:10 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7ef569e7 ebuild-writing/variables: Add section about reserved variables Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/variables/text.xml | 35 +++ 1 file changed, 35 insertions(+) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 4c7df4f..d77f4b7 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -721,6 +721,41 @@ table. + +Variables reserved for the package manager + + + +Variables and functions that begin with any of the following strings (ignoring +case) are reserved for package manager use. Ebuilds must neither use them nor +rely upon them: + + + + __ (two underscores) + abort + dyn + prep + + + +The same applies to functions and variables that contain any of the following +strings (ignoring case): + + + + +ebuild (unless immediately preceded by another letter, and except +for the EBUILD_PHASE and EBUILD_PHASE_FUNC variables) + + hook + paludis + portage + + + + + Version and Name Formatting Issues
[gentoo-commits] proj/devmanual:master commit in: general-concepts/copyright-policy/
commit: fda14234ce15ae7aaf07efd55a3ad3c44dcda9a7 Author: Ulrich Müller gentoo org> AuthorDate: Fri Jun 24 16:55:14 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Jun 25 06:16:09 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fda14234 general-concepts/copyright-policy: Drop a link There is a link to GLEP 76 immediately above and another in the same sentence. Signed-off-by: Ulrich Müller gentoo.org> general-concepts/copyright-policy/text.xml | 7 +++ 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/general-concepts/copyright-policy/text.xml b/general-concepts/copyright-policy/text.xml index a4ad96e..60a022d 100644 --- a/general-concepts/copyright-policy/text.xml +++ b/general-concepts/copyright-policy/text.xml @@ -5,7 +5,7 @@ -https://www.gentoo.org/glep/glep-0076.html";>GLEP-76 defines +https://www.gentoo.org/glep/glep-0076.html";>GLEP 76 defines copyright and license policies for Gentoo Linux. @@ -25,9 +25,8 @@ Foundation per-case basis. -Per https://www.gentoo.org/glep/glep-0076.html";>GLEP 76 -(Copyright Policy), you must sign-off all your commits to any -Gentoo-hosted repository with accordance to the +Per GLEP 76, you must sign-off all your commits to any Gentoo-hosted repository +with accordance to the https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin";> copyright policy.
1 2 3 4 5 6 7 8 9 10 >
