[gentoo-commits] proj/devmanual:master commit in: tools-reference/bash/
commit: 512c283a0345ed0c4c72f08a3d60f024d704873c Author: Ulrich Müller gentoo org> AuthorDate: Sat May 21 08:14:11 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 09:01:36 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=512c283a tools-reference/bash: Rework table on file comparison - Replace "same device and inode numbers" by "hard link". - Fix grammar (remove "if"). - Remove full stops (according to style guide). Signed-off-by: Ulrich Müller gentoo.org> tools-reference/bash/text.xml | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tools-reference/bash/text.xml b/tools-reference/bash/text.xml index cb5522a..092e95d 100644 --- a/tools-reference/bash/text.xml +++ b/tools-reference/bash/text.xml @@ -360,8 +360,8 @@ available (lifted from man bash): -The general form of a file comparison is "file1" -operator "file2". The -following are available (lifted from man bash): +The general form of a file comparison is "file1" -operator "file2". +The following are available: @@ -373,16 +373,16 @@ following are available (lifted from man bash): file1 -nt file2 file1 is newer (according to modification date) than file2, -or if file1 exists and file2 does not. +or file1 exists and file2 does not file1 -ot file2 - file1 is older than file2, or if file2 exists and file1 does not. + file1 is older than file2, or file2 exists and file1 does not file1 -ef file2 - file1 and file2 refer to the same device and inode numbers. + file1 is a hard link to file2
[gentoo-commits] proj/devmanual:master commit in: tools-reference/bash/
commit: 3690be148e96c428e51ff9f21b7572e100772e5f
Author: Ulrich Müller gentoo org>
AuthorDate: Fri May 20 09:23:16 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Fri May 27 09:01:34 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3690be14
tools-reference/bash: Drop redundant quotation marks in [[ ]] tests
Remove a note that was recommending them. Use {} braces around
variable names throughout.
Signed-off-by: Ulrich Müller gentoo.org>
tools-reference/bash/text.xml | 24 +---
1 file changed, 9 insertions(+), 15 deletions(-)
diff --git a/tools-reference/bash/text.xml b/tools-reference/bash/text.xml
index 821d385..d00a65c 100644
--- a/tools-reference/bash/text.xml
+++ b/tools-reference/bash/text.xml
@@ -91,19 +91,19 @@ To do comparisons or file attribute tests, [[ ]]
(preferred) or
-# is $foo zero length?
-if [[ -z "${foo}" ]] ; then
+# is ${foo} zero length?
+if [[ -z ${foo} ]] ; then
die "Please set foo"
fi
-# is $foo equal to "moo"?
-if [[ "${foo}" == "moo" ]] ; then
+# is ${foo} equal to "moo"?
+if [[ ${foo} == "moo" ]] ; then
einfo "Hello Larry"
fi
-# does "${ROOT}/etc/deleteme" exist?
-if [[ -f "${ROOT}/etc/deleteme" ]] ; then
- einfo "Please delete ${ROOT}/etc/readme manually!"
+# does ${ROOT}/etc/deleteme exist?
+if [[ -f ${ROOT}/etc/deleteme ]] ; then
+ einfo "Please delete ${ROOT}/etc/deleteme manually!"
fi
@@ -134,9 +134,9 @@ syntax is possible with the former. For a simple
illustration, consider:
-bash$ [ -n $foo ] [ -z $foo ] echo "huh?"
+bash$ [ -n ${foo} ] [ -z ${foo} ] echo "huh?"
huh?
-bash$ [[ -n $foo ]] [[ -z $foo ]] echo "huh?"
+bash$ [[ -n ${foo} ]] [[ -z ${foo} ]] echo "huh?"
bash$
@@ -242,12 +242,6 @@ available:
-
-To check whether a variable is set and not blank, use -n "${BLAH}"
-rather than -n $BLAH. The latter will cause problems in some situations
if
-the variable is unset.
-
-
[gentoo-commits] proj/devmanual:master commit in: tools-reference/bash/
commit: e86df6843bedc2c51b2bb0947e45b802ede88033 Author: Ulrich Müller gentoo org> AuthorDate: Fri May 20 09:54:57 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 09:01:35 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e86df684 tools-reference/bash: Fix a typo lexiographic -> lexicographic Signed-off-by: Ulrich Müller gentoo.org> tools-reference/bash/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools-reference/bash/text.xml b/tools-reference/bash/text.xml index 0a7c33f..cb5522a 100644 --- a/tools-reference/bash/text.xml +++ b/tools-reference/bash/text.xml @@ -167,11 +167,11 @@ following are available: - String lexiographic comparison (before) + String lexicographic comparison (before) - String lexiographic comparison (after) + String lexicographic comparison (after) =~
[gentoo-commits] proj/devmanual:master commit in: tools-reference/bash/
commit: 3a69349de3d0c6ddc7eb27afd20f3416ece67ad1 Author: Ulrich Müller gentoo org> AuthorDate: Fri May 20 09:49:35 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 09:01:35 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3a69349d tools-reference/bash: More compact table formatting in source code No change of text. Signed-off-by: Ulrich Müller gentoo.org> tools-reference/bash/text.xml | 796 ++ 1 file changed, 270 insertions(+), 526 deletions(-) diff --git a/tools-reference/bash/text.xml b/tools-reference/bash/text.xml index ee1d7e3..0a7c33f 100644 --- a/tools-reference/bash/text.xml +++ b/tools-reference/bash/text.xml @@ -153,54 +153,30 @@ following are available: - - - Operator - - - Purpose - - - - - == (also =) - - - String equality - - - - - != - - - String inequality - - - - - - - - String lexiographic comparison (before) - - - - - - - - String lexiographic comparison (after) - - - - - =~ - - - String regular expression match - - + + Operator + Purpose + + + == (also =) + String equality + + + != + String inequality + + + + String lexiographic comparison (before) + + + + String lexiographic comparison (after) + + + =~ + String regular expression match + @@ -216,30 +192,18 @@ available: - - - Operator - - - Purpose - - - - - -z "string" - - - String has zero length - - - - - -n "string" - - - String has non-zero length - - + + Operator + Purpose + + + -z "string" + String has zero length + + + -n "string" + String has non-zero length + @@ -255,62 +219,34 @@ following are available: - - - Operator - - - Purpose - - - - - -eq - - - Integer equality - - - - - -ne - - - Integer inequality - - - - - -lt - - - Integer less than - - - - - -le - - - Integer less than or equal to - - - - - -gt - - - Integer greater than - - - - - -ge - - - Integer greater than or equal to - - + + Operator + Purpose + + + -eq + Integer equality + + + -ne + Integer inequality + + + -lt + Integer less than + + + -le + Integer less than or equal to + + + -gt + Integer greater than + + + -ge + Integer greater than or equal to + @@ -326,182 +262,94 @@ available (lifted from man bash): - - - Operator - - - Purpose - - - - - -a file - - - Exists (use -e instead) - - - - - -b file - - - Exists and is a block special file - - - - - -c file - - - Exists and is a character special file - - - - - -d file - - - Exists and is a directory - - - - - -e file - - - Exists - - - - - -f file - - - Exists and is a regular file - - - - - -g file - - - Exists and is set-group-id - - - - - -h file - - - Exists and is a symbolic link - - - - - -k file - - - Exists and its sticky bit is set - - - - - -p file - - - Exists and is a named pipe (FIFO) - - - - - -r file - - - Exists and is readable - - - - - -s file - - - Exists and has a size greater than zero - - - - - -t fd - - - Descriptor fd is open and refers to a terminal - - - - - -u file - - - Exists and its set-user-id bit is set - - - - - -w file - - - Exists and is writable - - - - - -x file - - - Exists and is executable - - - - - -O file - - - Exists and is owned by the effective user id - - - - - -G file - - - Exists and is owned by the effective group id - - - - - -L file - - - Exists and is a symbolic link - - - - - -S file - - - Exists and is a socket - - - - - -N file - - - Exists and has been modified since it was last read - - + + Operator + Purpose + + + -a file + Exists (use -e instead) + + + -b file + Exists and is a block special file + + + -c file + Exists and is a character special file + + + -d file + Exists and is a directory + + + -e file + Exists + + + -f file + Exists and is a regular file + + + -g file + Exists and is set-group-id + + + -h file + Exists
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: 94057052e439ab6fe70cb0560211ce36d56ec2b8 Author: Ulrich Müller gentoo org> AuthorDate: Fri May 27 08:59:21 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Fri May 27 08:59:21 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=94057052 general-concepts/dependencies: Whitespace Fixes: d08d5f0dea3d8580c55a052d6424863d6aeb8ae9 Fixes: 6c0b51ae63833c2ddfd58412727c0004db06d605 Signed-off-by: Ulrich Müller gentoo.org> general-concepts/dependencies/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index 59b1b37..0ff903d 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -631,7 +631,7 @@ package: Use a tool like scanelf -n (from app-misc/pax-utils) or objdump -p (from sys-devel/binutils) to list DT_NEEDED -entries. +entries. app-portage/iwdevtools and portage's own qa-unresolved-soname-deps FEATURE can help finding these. @@ -804,7 +804,7 @@ requirements. For example, a package needs dep1 and dep2, but dep1 since it currently pulls dep2 too, but in the future, dep1 might drop dep2 as a dependency, or make it conditional with USE flags. This would then break building your ebuild. - +
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: d08d5f0dea3d8580c55a052d6424863d6aeb8ae9 Author: Joonas Niilola gentoo org> AuthorDate: Sat Apr 23 12:32:51 2022 + Commit: Joonas Niilola gentoo org> CommitDate: Sun May 22 06:36:57 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d08d5f0d general-concepts/dependencies: add new section for indirect deps Signed-off-by: Joonas Niilola gentoo.org> general-concepts/dependencies/text.xml | 17 + 1 file changed, 17 insertions(+) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index ef27ac2..ab1a799 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -781,6 +781,23 @@ There are three kinds of circular dependencies: + + + + +Indirect dependencies + + + +Always list each direct dependency that your package needs to build and run +correctly. Do not rely on dependency chains to meet the dependency +requirements. For example, a package needs dep1 and dep2, but +dep1 also depends on dep2. You might consider just adding +dep1 since it currently pulls dep2 too, but in the future, +dep1 might drop dep2 as a dependency, or make it conditional with +USE flags. This would then break building your ebuild. + +
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: 6c0b51ae63833c2ddfd58412727c0004db06d605 Author: Joonas Niilola gentoo org> AuthorDate: Sat Apr 23 12:42:10 2022 + Commit: Joonas Niilola gentoo org> CommitDate: Sun May 22 06:37:02 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6c0b51ae general-concepts/dependencies: expand on finding correct deps a bit Signed-off-by: Joonas Niilola gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/284 general-concepts/dependencies/text.xml | 14 +++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index ab1a799..59b1b37 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -631,7 +631,9 @@ package: Use a tool like scanelf -n (from app-misc/pax-utils) or objdump -p (from sys-devel/binutils) to list DT_NEEDED -entries +entries. +app-portage/iwdevtools and portage's own qa-unresolved-soname-deps +FEATURE can help finding these. Look in configure.ac @@ -647,12 +649,12 @@ package: Look at the application/library website Check the application website for possible dependencies that they suggest -are needed +are needed. Read the README and INSTALL for the package They usually also contain useful information about building and installing -packages +packages. Remember non-binary dependencies such as pkg-config, doc generation @@ -664,6 +666,12 @@ package: are clearly stated. Again, such dependencies usually belong in BDEPEND. + Testing in chroots, containers and virtual machines + +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. +
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: b99e3d57965f00401a37041564a029d96ec788b2
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Sat Apr 30 11:32:28 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sat Apr 30 16:58:44 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b99e3d57
eclass-writing: minor edits to jmake example
Double space after full stop. Add full stop to sentence.
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
[Wrap paragraph at column 72.]
Signed-off-by: Ulrich Müller gentoo.org>
eclass-writing/text.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 8c83dc2..9f5fbdf 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -801,7 +801,7 @@ functions.
# @DESCRIPTION:
# Demonstrates EXPORT_FUNCTIONS and defines simple wrappers for the
# (hypothetical) jmake build system along with default src_configure and
-# src_compile phase functions
+# src_compile phase functions.
case ${EAPI} in
7|8) ;;
@@ -825,8 +825,8 @@ jmake-configure() {
# @FUNCTION: jmake_src_configure
# @USAGE: [additional-args]
# @DESCRIPTION:
-# Calls jmake-configure() to configure a jmake project. Passes all arguments
-# through to the appropriate "jmake configure" command.
+# 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"
}
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: f219b1c2f633f5f3bc00b02d1237c3cc345f7f26
Author: Ulrich Müller gentoo org>
AuthorDate: Tue Apr 26 08:18:43 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Tue Apr 26 08:18:43 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f219b1c2
eclass-writing: Sentence ends should be followed by two spaces
Signed-off-by: Ulrich Müller gentoo.org>
eclass-writing/text.xml | 10 --
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 22b973f..8c83dc2 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -172,6 +172,12 @@ in the tree or pkgcheck scan --commits to check for
issues
in your staged git commits.
+
+In eclass documentation, two spaces should be used after the end of each
+sentence (unless it is followed by a newline). This will help groff
+to properly break lines when generating eclass manpages.
+
+
@@ -597,9 +603,9 @@ a single function, domacosapp.
# @FUNCTION: domacosapp
# @USAGE: app-file [new-file]
# @DESCRIPTION:
-# Install the given .app file into the appropriate location. If
+# Install the given .app file into the appropriate location. If
# [new-file] is given, it will be used as the new (installed) name of
-# the file. Otherwise app-file is installed as-is.
+# the file. Otherwise app-file is installed as-is.
domacosapp() {
[[ -z "${1}" ]] die "usage: domacosapp file [new
file]"
if use ppc-macos ; then
[gentoo-commits] proj/devmanual:master commit in: bin/
commit: a5bd4baa0047470e2be18ac6404347207562f0a4
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Apr 24 11:42:22 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Tue Apr 26 04:37:23 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a5bd4baa
bin/gen-eclass-html.sh: Don't show mailto links
man2html's heuristic for recognition of e-mail addresses is
unreliable, therefore drop them all.
Reported-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Ulrich Müller gentoo.org>
bin/gen-eclass-html.sh | 1 +
1 file changed, 1 insertion(+)
diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh
index df759e0..6021c1e 100755
--- a/bin/gen-eclass-html.sh
+++ b/bin/gen-eclass-html.sh
@@ -149,6 +149,7 @@ for i in "${MANPAGES[@]}"; do
-e 's:\([^<>]*\):\1:g' \
-e 's:\([^<>]*\):\1:g' \
-e 's:\([^<>]*\):\1:g' \
+ -e 's,mailto:[^"]*;>\([^<>]*\),\1,g' \
-e 's:\([^<>]*\):\1:g' \
-e 's:::g' \
-e 's:::g' \
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: be55691ed16c2ab4dd7c3d635fc2bd67ecd6b563
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Fri Apr 15 21:42:03 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Apr 24 12:51:53 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=be55691e
eclass-writing: doc inherit guards, EXPORT_FUNCTIONS warning
Add a section to explain what inherit guards are and their usage, and
add a "rule of thumb" to put EXPORT_FUNCTIONS at the end of eclasses for
max portability.
This turned into a larger re-ordering of the sections so the full jmake
example can showcase all the features discussed in the preceding
sections, like EAPI guard, inherit guard, and EXPORT_FUNCTIONS at the
very end.
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Ulrich Müller gentoo.org>
eclass-writing/text.xml | 156 +---
1 file changed, 122 insertions(+), 34 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index f0f03c0..22b973f 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -638,11 +638,11 @@ eclass-defined defaults for example, say we had
fnord.eclass:
-EXPORT_FUNCTIONS src_compile
-
fnord_src_compile() {
do_stuff || die
}
+
+EXPORT_FUNCTIONS src_compile
@@ -659,6 +659,115 @@ src_compile() {
}
+
+Eclasses may inherit other eclasses to make use of their functionality, and
+historically there have been instances of eclasses calling
+EXPORT_FUNCTIONS and then inheriting another eclass. As inherited
+eclasses may also execute EXPORT_FUNCTIONS, it was not fully defined
+which defaults should take effect. The general recommendation is now that
+eclasses should not inherit other eclasses after calling
+EXPORT_FUNCTIONS.
+
+
+
+
+
+
+Inherit guards
+
+
+
+It is common practice to surround the main contents of an eclass with an
+"inherit guard". Much like header guards known from C, inherit guards help
+ensure that an eclass can be inherited multiple times and have its functions
and
+variables defined only once. An inherit guard is only needed for an eclass that
+can be inherited more than once.
+
+
+
+A typical inherit guard looks as follows (for a hypothetical
foo.eclass):
+
+
+
+if [[ -z ${_FOO_ECLASS} ]]; then
+_FOO_ECLASS=1
+
+# Variables and functions go here
+
+fi
+
+
+
+When it comes to EXPORT_FUNCTIONS and inherit guards, the call to
+EXPORT_FUNCTIONS must be placed at the very end of the eclass
+outside any inherit guards, like this:
+
+
+
+if [[ -z ${_FOO_ECLASS} ]]; then
+_FOO_ECLASS=1
+
+foo_src_compile() {
+ ...
+}
+fi
+
+EXPORT_FUNCTIONS src_compile
+
+
+
+This helps to ensure that the last inherited eclass gets to define the default
+phase functions. Consider two eclasses foo.eclass and bar.eclass
+that define the same default phase function via EXPORT_FUNCTIONS. If an
+ebuild inherits both as inherit foo bar, then the default phases are
+defined by bar.eclass. If foo.eclass is then modified to inherit
+bar as well, then the ebuild's default functions could suddenly become
+those from foo if EXPORT_FUNCTIONS was placed inside the inherit
+guard.
+
+
+
+The rule of thumb here is: put the call (if any) to EXPORT_FUNCTIONS in
+the last line of an eclass, outside of any inherit guards.
+
+
+
+Old eclasses may put EXPORT_FUNCTIONS in other places, even before
+inherit. They should not blindly be updated to follow the
+recommended pattern here, as it could result in significant breakage.
+
+
+
+
+
+
+Handling incorrect usage of an eclass
+
+
+
+Sometimes an eclass is used incorrectly by an ebuild and the eclass
+knows it is being used incorrectly the common example is an
+eclass that only works with a specific set of EAPIs, but is being
+accessed (inherited) by an ebuild with a different EAPI.
+In those cases, used sparingly as a last resort, it is allowed
+for an eclass to invoke die from the global scope. For example:
+
+
+
+# Copyright 1999-2022 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+# @ECLASS: eapi-die.eclass
+# @MAINTAINER:
+# Gentoo Devmanual Project devman...@gentoo.org
+# @SUPPORTED_EAPIS: 7 8
+# @BLURB: Calls die when used with an invalid EAPI.
+
+case ${EAPI} in
+ 7|8) ;;
+ *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
+esac
+
@@ -674,7 +783,7 @@ functions.
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: jmake.eclass
@@ -688,7 +797,13 @@ functions.
# (hypothetical) jmake build system along with default src_configure and
# src_compile phase functions
-EXPORT_FUNCTIONS src_configure src_compile
+case ${EAPI} in
+ 7|8) ;;
+ *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
+esac
+
+if [[ -z ${_JMAKE_ECLASS} ]]; then
+_JMAKE_ECLASS=1
BDEPEND="=sys-devel/jmake-2"
@@ -725,40 +840,13 @@
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/patches/
commit: dcb57d688530aa1af4193aaec350d6d7f571c6cf
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Sun Mar 27 20:17:34 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Apr 6 18:40:39 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dcb57d68
ebuild-writing/patches: Add "Conditional patching" section
The added section under "Patches" tries to describe what patches are
intended for and why conditional patching should be avoided.
It was pointed out in a PR review that conditional patching in general
should be avoided as it introduces more variance and can make it harder
to debug breakage if a patch is only applied under certain conditions
(USE flags being the primary example).
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/misc-files/patches/text.xml | 59 ++
1 file changed, 59 insertions(+)
diff --git a/ebuild-writing/misc-files/patches/text.xml
b/ebuild-writing/misc-files/patches/text.xml
index 05052e6..87b4a7e 100644
--- a/ebuild-writing/misc-files/patches/text.xml
+++ b/ebuild-writing/misc-files/patches/text.xml
@@ -112,6 +112,65 @@ from the vim patch tarball:
+
+Conditional patching
+
+
+
+Patching is ideally only done to make the package in question build properly,
+and should not be done to modify the runtime behaviour of the package. This is
+what USE flags and features of the package are for. As such, it is preferable
to
+apply patches unconditionally and avoid conditional patching.
+
+
+
+There are a number of reasons to avoid conditional patching:
+
+
+
+
+It may go unnoticed that a patch fails to apply, if a package is not being
+tested with a given flag
+
+
+More variance is introduced and problems with a package can become much
more
+difficult to debug
+
+
+Patches should preferably be upstreamed, but conditional patches cannot
+
+
+
+
+Consider the following example src_prepare() implementation:
+
+
+
+src_prepare() {
+ if use threads; then
+ PATCHES+=( "${FILESDIR}"/${P}-mt.patch )
+ fi
+ default
+}
+
+
+
+As this patch is only applied when USE="threads" is set, any developer
+creating new versions of this package might not detect whether the patch
applies
+successfully if they don't test with the same flag.
+
+
+
+Although conditional patching is discouraged it can be unavoidable and as such,
+it is not considered a banned practice, but, to the extent possible, patches
+should be written such that they affect behaviour correctly based on e.g. build
+time definitions and configuration options rather than USE flags directly. This
+allows them to be applied unconditionally.
+
+
+
+
+
Clean Patch Howto
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: d03e2375564ef7eb7a95b26e4f8318b7ca88526f Author: Ulrich Müller gentoo org> AuthorDate: Wed Mar 30 16:07:17 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Mar 30 16:07:17 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d03e2375 ebuild-writing/user-submitted: Add cross-reference to copyright policy Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/user-submitted/text.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index a389677..364fa87 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -36,6 +36,8 @@ git commit's --author parameter to explicitly give them credit. Developers must check for a valid Signed-off-by line either within the provided patches by a user or within a comment on e.g. Bugzilla. +See +for details.
[gentoo-commits] proj/devmanual:master commit in: /, bin/
commit: e40ff7c7974e62e8be5a7edb4b53f2b3b0954ed7 Author: Ulrich Müller gentoo org> AuthorDate: Sat Mar 26 19:12:38 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Mar 26 19:12:38 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e40ff7c7 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 7274aa2..df759e0 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-2021 Gentoo Authors +Copyright (C) 2001-2022 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 bf68e9a..9a254a7 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -661,7 +661,7 @@ - Copyright (C) 2001-2021 Gentoo Authors + Copyright (C) 2001-2022 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: eclass-writing/
commit: e45f656f8c5b18c258c14ff0da08ffc37f2c9c23 Author: Ulrich Müller gentoo org> AuthorDate: Sat Mar 26 16:14:58 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Sat Mar 26 16:14:58 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e45f656f eclass-writing: @DEPRECATED must be followed by a colon 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 be57372..f0f03c0 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -138,7 +138,7 @@ adhere to the following process: -Before considering removal, please mark the eclass as # @DEPRECATED +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. @@ -380,7 +380,7 @@ variables are as follows: Indicates that this variable must be set by the developer - @DEPRECATED + @DEPRECATED: No Optionally, the name of any replacement variable Declares that this variable should no longer be used in ebuilds @@ -474,7 +474,7 @@ documentation are: - @DEPRECATED + @DEPRECATED: No Optionally, the name of a replacement function Declares that this function should no longer be used in ebuilds @@ -559,7 +559,7 @@ using the following tags: Indicates that this variable must be set by the developer - @DEPRECATED + @DEPRECATED: No Optionally, the name of any replacement variable Declares that this variable should no longer be used in ebuilds
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 108416f08c8e241b57c05ab4dbce6212eb2a6d87 Author: Ulrich Müller gentoo org> AuthorDate: Thu Mar 17 11:28:33 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Mar 23 14:06:36 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=108416f0 eclass-writing: @ECLASS-VARIABLE renamed to @ECLASS_VARIABLE Bug: https://bugs.gentoo.org/835396 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 795ccd0..be57372 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -311,7 +311,7 @@ variables are as follows: description - @ECLASS-VARIABLE: + @ECLASS_VARIABLE: Yes Name of the eclass variable to which the documentation applies
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 3dfa91c478c62400e5849158679bb2e91db7d4da
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Fri Mar 18 19:54:32 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Mar 20 13:46:52 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3dfa91c4
eclass-writing: Use "required" instead of "not optional"
When figuring out if a documentation tag is required, the reader must
mentally handle "not optional" as "required". Simplify by changing the
"optional?" column to "required?".
Let us also stop shouting at the reader, so change "YES" and "NO" to
"Yes" and "No".
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Ulrich Müller gentoo.org>
eclass-writing/text.xml | 82 -
1 file changed, 41 insertions(+), 41 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 0e6ca99..795ccd0 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -197,13 +197,13 @@ summarizes the available documentation tags:
tag
- optional?
+ required?
arguments
description
@ECLASS:
- NO
+ Yes
Name of the eclass being documented
Documents various information about the eclass. Must appear as the
@@ -212,7 +212,7 @@ summarizes the available documentation tags:
@MAINTAINER:
- NO
+ Yes
One or more name and email pairs
List of maintainers for the eclass to be contacted. One line per
@@ -221,7 +221,7 @@ summarizes the available documentation tags:
@AUTHOR:
- YES
+ No
One or more name and email pairs
List of authors for the eclass. One line per author. Must start on
@@ -230,25 +230,25 @@ summarizes the available documentation tags:
@BUGREPORTS:
- YES
+ No
Multiline freetext
Describes how bugs related to this eclass should be reported
@VCSURL:
- YES
+ No
A URI string
Points to the URL of the VCS that contains the eclass source
@SUPPORTED_EAPIS:
- YES
+ No
Space-separated list of EAPIs
List of EAPIs supported by this eclass
@PROVIDES:
- YES
+ No
Space-separated list of eclass names
List of indirectly inherited eclasses whose functions and variables may be
@@ -257,7 +257,7 @@ summarizes the available documentation tags:
@BLURB:
- NO
+ Yes
Single line freetext
Contains a short description for the eclass. Must be on the same
@@ -266,19 +266,19 @@ summarizes the available documentation tags:
@DEPRECATED:
- YES
+ No
Replacement (or "none")
Declares that this eclass should no longer be used
@DESCRIPTION:
- YES
+ No
Multiline freetext
Long description for the eclass
@EXAMPLE:
- YES
+ No
Multiline freetext
Examples that illustrate various uses of this eclass
@@ -306,13 +306,13 @@ variables are as follows:
tag
- optional?
+ required?
arguments
description
@ECLASS-VARIABLE:
- NO
+ Yes
Name of the eclass variable to which the documentation applies
This tag applies to eclass specific variables that affect the
@@ -323,7 +323,7 @@ variables are as follows:
@PRE_INHERIT
- YES
+ No
This tag describes whether the variable must be defined before
@@ -333,7 +333,7 @@ variables are as follows:
@USER_VARIABLE
- YES
+ No
This tag describes whether the variable is unsuitable for use in ebuilds,
@@ -343,7 +343,7 @@ variables are as follows:
@OUTPUT_VARIABLE
- YES
+ No
This tag indicates that the variable's value (which will be set by the
@@ -352,7 +352,7 @@ variables are as follows:
@DEFAULT_UNSET
- YES
+ No
Indicates that this variable is unset by default if not set by the
@@ -361,7 +361,7 @@ variables are as follows:
@INCLUDES_EPREFIX
- YES
+ No
Indicates that the variable is a path which has ${EPREFIX} prepended to it
@@ -369,25 +369,25 @@ variables are as follows:
@INTERNAL
- YES
+ No
Indicates that the variable is internal to the eclass
@REQUIRED
- YES
+ No
Indicates that this variable must be set by the developer
@DEPRECATED
- YES
+ No
Optionally, the name of any replacement variable
Declares that this variable should no longer be used in ebuilds
@DESCRIPTION:
- NO
+ Yes
Multiline freetext
Long description for the eclass variable
@@ -414,13 +414,13 @@ documentation are:
tag
- optional?
+ required?
arguments
description
@FUNCTION:
- NO
+ Yes
Name of the function to which the documentation block applies
Documents information about an eclass function such as its calling
@@ -429,7 +429,7 @@ documentation are:
@USAGE:
- NO
+ Yes
List of required and optional arguments to the function
List of arguments that the eclass function accepts, specified in
@@ -443,12 +443,12 @@ documentation are:
Return value of the
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 3214de4c965e8bc94c7f14f7f0d52c117df7a3cd
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Wed Mar 16 14:12:36 2022 +
Commit: Sam James gentoo org>
CommitDate: Fri Mar 18 18:10:17 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3214de4c
eclass-writing: Add default src_configure to jmake example
The jmake sample eclass was written before EAPI 2 and thus predates
src_configure() where configuration and compilation where both handled
in src_compile().
Now it makes sense to have a separate jmake_src_configure() that is used
as the default src_configure().
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Sam James gentoo.org>
eclass-writing/text.xml | 19 ++-
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 5378184..f5bb88b 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -667,7 +667,7 @@ src_compile() {
-A simple eclass which defines a number of functions and a default
+A simple eclass which defines a number of functions and default
src_confgure and
src_compile for the (hypothetical) jmake build system might look
something like the following:
@@ -684,9 +684,10 @@ something like the following:
# @BLURB: Demonstrate a simple build system eclass.
# @DESCRIPTION:
# Demonstrates EXPORT_FUNCTIONS and defines simple wrappers for the
-# (hypothetical) jmake build system and a default src_compile.
+# (hypothetical) jmake build system along with default src_configure and
+# src_compile phase functions
-EXPORT_FUNCTIONS src_compile
+EXPORT_FUNCTIONS src_configure src_compile
BDEPEND="=sys-devel/jmake-2"
@@ -699,6 +700,15 @@ jmake-configure() {
jmake configure --prefix=/usr "$@"
}
+# @FUNCTION: jmake_src_configure
+# @USAGE: [additional-args]
+# @DESCRIPTION:
+# 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"
+}
+
# @FUNCTION: jmake-build
# @USAGE: [additional-args]
# @DESCRIPTION:
@@ -710,9 +720,8 @@ jmake-build() {
# @FUNCTION: jmake_src_compile
# @DESCRIPTION:
-# Calls jmake-configure() and jmake-build() to compile a jmake project.
+# Calls jmake-build() to compile a jmake project.
jmake_src_compile() {
- jmake-configure || die "configure failed"
jmake-build || die "build failed"
}
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: d26cb56cf88ca73b321ffa7f601d86ab682cc206
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Fri Mar 18 05:38:58 2022 +
Commit: Sam James gentoo org>
CommitDate: Fri Mar 18 18:10:19 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d26cb56c
eclass-writing: Rework intro paragraph for jmake example
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Closes: https://github.com/gentoo/devmanual/pull/278
Signed-off-by: Sam James gentoo.org>
eclass-writing/text.xml | 7 ---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index f5bb88b..0e6ca99 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -667,9 +667,10 @@ src_compile() {
-A simple eclass which defines a number of functions and default
src_confgure and
-src_compile for the (hypothetical) jmake build system might look
-something like the following:
+Here is an example of how a simple eclass for a hypothetical jmake build
+system might look. The eclass defines a few functions, along with default
+implementations for the src_configure and src_compile phase
+functions.
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: d6b166b300d41e20b5e58d2a1324af626b0fc85a
Author: Sam James gentoo org>
AuthorDate: Fri Mar 18 02:07:20 2022 +
Commit: Sam James gentoo org>
CommitDate: Fri Mar 18 02:07:20 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d6b166b3
quickstart: add missing quote in example
Reported-by: dfdx
Signed-off-by: Sam James gentoo.org>
quickstart/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/quickstart/text.xml b/quickstart/text.xml
index 9847477..c15af51 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -218,7 +218,7 @@ KEYWORDS="~hppa ~mips sparc x86"
RDEPEND="dev-libs/popt"
DEPEND="${RDEPEND}
- sys-devel/flex
+ sys-devel/flex"
BDEPEND="sys-devel/bison"
src_configure() {
[gentoo-commits] proj/devmanual:master commit in: profiles/package.mask/
commit: 15dee0505f502a5eb3a248257b61f02f3f30bee9 Author: Sam James gentoo org> AuthorDate: Tue Mar 15 19:01:59 2022 + Commit: Sam James gentoo org> CommitDate: Wed Mar 16 14:51:48 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=15dee050 profiles/package.mask: mention masking development versions Closes: https://bugs.gentoo.org/319927 Signed-off-by: Sam James gentoo.org> profiles/package.mask/text.xml | 19 +++ 1 file changed, 19 insertions(+) diff --git a/profiles/package.mask/text.xml b/profiles/package.mask/text.xml index dd37b9b..299d153 100644 --- a/profiles/package.mask/text.xml +++ b/profiles/package.mask/text.xml @@ -14,6 +14,25 @@ have a comment detailing the specific reason for the mask. The format of the package.mask file is described in man portage. + +Development or unstable (per upstream declaration/categorization) versions of +packages should usually be masked in package.mask. Upstreams may not +deem such releases to be ready for general distribution (or safe to use), or +may not be expecting bug reports from the wider userbase yet. The default +should generally be to mask such versions, but it is acceptable to not mask +in some circumstances e.g. upstream make very infrequent releases, the +changes are safe (reviewed by the Gentoo maintainer), or perhaps other +distributions are shipping the same new version. As an alternative to a +development version, you may also consider backporting required upstream fixes +to the released version. + + + +Overall, masking something and unmasking if it turns out to be stable is +safer (and leads to a better user experience) than the inverse (pushing +unmasked and breakage occurring). + + Entries are added chronologically that is, newer entries should be placed towards the top of the file, underneath any initial
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: a4d5e702ddea5f01980e667d6673decdcc8a68e9 Author: Sam James gentoo org> AuthorDate: Tue Mar 1 09:49:54 2022 + Commit: Sam James gentoo org> CommitDate: Wed Mar 16 14:51:50 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a4d5e702 keywording: describe pending stabilization requests Describe how maintainers should keep track of (and know when to file) pending stabilization requests. Signed-off-by: Sam James gentoo.org> keywording/text.xml | 30 ++ 1 file changed, 30 insertions(+) diff --git a/keywording/text.xml b/keywording/text.xml index 74224a0..c5b5660 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -429,6 +429,36 @@ stable for one of these architectures. + +Keeping track of pending stabilizations + + + +Maintainers need some method or system to organize and start pending +stabilizations once they become due. + + + +There are several tools available that can help with this: + + + + +Use imlate from app-portage/gentoolkit + + +Use packages.gentoo.org's maintainer pages (which have a Stabilization +tab) + + +Use pkgcheck's StableRequest check, e.g. + grep -ri "larry@" */*/metadata.xml -l | cut -d'/' -f1-2 | xargs pkgcheck scan -k StableRequest + + + + + + Simultaneous stabilization on all architectures
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 47753e7ad55a22f24ebfab53a4bb6a03272b7f9f
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Wed Mar 16 13:17:34 2022 +
Commit: Sam James gentoo org>
CommitDate: Wed Mar 16 14:46:08 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=47753e7a
eclass-writing: fix typo jmake-src_compile -> jmake_src_compile
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Closes: https://github.com/gentoo/devmanual/pull/277
Signed-off-by: Sam James 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 41976c3..de6c0b2 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -708,7 +708,7 @@ jmake-build() {
jmake dep jmake build "$@"
}
-# @FUNCTION: jmake-src_compile
+# @FUNCTION: jmake_src_compile
# @DESCRIPTION:
# Calls jmake-configure() and jmake-build() to compile a jmake project.
jmake_src_compile() {
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 59ae980db874417e300bd2b9ca57dffcaba12087
Author: Sam James gentoo org>
AuthorDate: Wed Mar 16 14:47:21 2022 +
Commit: Sam James gentoo org>
CommitDate: Wed Mar 16 14:47:21 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=59ae980d
eclass-writing: tweak confusing typo
Signed-off-by: Sam James 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 de6c0b2..5378184 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -728,7 +728,7 @@ jmake_src_compile() {
Sometimes an eclass is used incorrectly by an ebuild and the eclass
knows it is being used incorrectly the common example is an
eclass that only works with a specific set of EAPIs, but is being
-accessed inherited by an ebuild with a different EAPI.
+accessed (inherited) by an ebuild with a different EAPI.
In those cases, used sparingly as a last resort, it is allowed
for an eclass to invoke die from the global scope. For example:
[gentoo-commits] proj/devmanual:master commit in: appendices/editor-configuration/
commit: 507c035652a3949b0d71a7dbc60a545df222b4cf Author: Ulrich Müller gentoo org> AuthorDate: Tue Mar 15 10:18:27 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 15 10:19:17 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=507c0356 appendices/editor-configuration: Typo Signed-off-by: Ulrich Müller gentoo.org> appendices/editor-configuration/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appendices/editor-configuration/text.xml b/appendices/editor-configuration/text.xml index 5bb9390..8c3356f 100644 --- a/appendices/editor-configuration/text.xml +++ b/appendices/editor-configuration/text.xml @@ -5,7 +5,7 @@ -This section provides hints as to how to configue your text editor for working +This section provides hints as to how to configure your text editor for working with ebuilds.
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 43a02db3cad737ea1ae574e63caa47a615a0bf20 Author: Matt Turner gentoo org> AuthorDate: Fri Mar 11 23:41:50 2022 + Commit: Matt Turner gentoo org> CommitDate: Mon Mar 14 17:06:38 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=43a02db3 keywording: Update arch status and stabilization notes Closes: https://github.com/gentoo/devmanual/pull/275 Signed-off-by: Matt Turner gentoo.org> keywording/text.xml | 13 - 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/keywording/text.xml b/keywording/text.xml index 30a7c73..74224a0 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -411,24 +411,19 @@ architecture, not for filing bugs to request arch teams to handle it. arrangements can be made if you will only be working with a small group of packages. - - -alpha: Maintainers may keyword their own packages but are reminded to -inform the Alpha team if they can help out with testing and keywording -packages so the team can keep an eye out for possible keywording mistakes. - -Exotic architectures (like hppa, ia64, ppc*, sparc) +Exotic architectures (like hppa, ppc*, sparc) are short on help, so it's best if you avoid opening bugs for stabilization of new packages for them, unless it is absolutely necessary (e.g., a reverse dependency for your package). -Some architectures (like mips, riscv) do not maintain a stable -keyword, so packages are not to be marked stable for one of these architectures. +Some architectures (alpha, ia64, mips, riscv, +s390) do not maintain a stable keyword, so packages are not to be marked +stable for one of these architectures.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/, general-concepts/manifest/, ...
commit: c2c0b163b73c53d8aa65ed6403bdf8f116ef45b8
Author: Matt Turner gentoo org>
AuthorDate: Fri Mar 11 21:12:26 2022 +
Commit: Matt Turner gentoo org>
CommitDate: Mon Mar 14 17:05:41 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c2c0b163
Remove references to repoman
Bug: https://bugs.gentoo.org/835013
Closes: https://github.com/gentoo/devmanual/pull/274
Signed-off-by: Matt Turner gentoo.org>
appendices/common-problems/text.xml| 2 +-
appendices/editor-configuration/emacs/text.xml | 4 +--
ebuild-maintenance/git/text.xml| 39 +++---
ebuild-maintenance/new-ebuild/text.xml | 8 +++---
ebuild-writing/common-mistakes/text.xml| 4 +--
ebuild-writing/file-format/text.xml| 6 ++--
ebuild-writing/misc-files/metadata/text.xml| 2 +-
eclass-writing/text.xml| 3 +-
general-concepts/ebuild-revisions/text.xml | 5 ++--
general-concepts/manifest/text.xml | 7 ++---
keywording/text.xml| 12 +---
tools-reference/text.xml | 3 --
12 files changed, 35 insertions(+), 60 deletions(-)
diff --git a/appendices/common-problems/text.xml
b/appendices/common-problems/text.xml
index 4fcdda4..d124070 100644
--- a/appendices/common-problems/text.xml
+++ b/appendices/common-problems/text.xml
@@ -161,7 +161,7 @@ directories Executable stacks ... binary files whose stack
is marked with
-Handling repoman Messages
+Handling pkgcheck Messages
diff --git a/appendices/editor-configuration/emacs/text.xml
b/appendices/editor-configuration/emacs/text.xml
index f822388..c90dba6 100644
--- a/appendices/editor-configuration/emacs/text.xml
+++ b/appendices/editor-configuration/emacs/text.xml
@@ -50,9 +50,7 @@ automatically before saving the file.
Other useful settings can be disabled backup files
(by (setq make-backup-files nil)), so you don't clutter the git
-repository
-directories and confuse repoman with it (by adding unnecessary entries
-into a Manifest file e.g.). Emacs can even contact the outside world
+repository directories. Emacs can even contact the outside world
by using the X servers clipboard abilities when yanking, which is
activated by (setq x-select-enable-clipboard t).
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index cf8d6ba..01a4da0 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -112,11 +112,10 @@ the historical commits after the initial git commit.
-The recommended way of committing to the Gentoo repository is to use repoman
-commit or pkgdev commit (then pkgdev push). It automatically
-performs the necessary QA checks on the package being committed and has other
-features helping with the Gentoo workflow. However, repoman is currently
-limited to creating a single commit to a single package.
+The recommended way of committing to the Gentoo repository is to use pkgdev
+commit (then pkgdev push). It automatically performs the necessary
+QA checks on the package being committed and has other features helping with
+the Gentoo workflow.
@@ -130,21 +129,19 @@ used. The valid uses of git include:
Gentoo repository (eclasses, licenses, profiles…),
-amending a commit created via repoman commit or pkgdev commit
-with additional files or fixups,
+amending a commit created via pkgdev commit with additional files
+or fixups,
-combining multiple commits created via repoman commit or
-pkgdev commit using git rebase.
+combining multiple commits created via pkgdev commit using
+git rebase.
-Whenever repoman or pkgdev is not used to commit, you need to
-manually verify all packages affected by the commit using repoman full
or
-pkgcheck scan --commits. When using repoman, it won't be aware of
-staged changes, so ensure that all files are included in the commit.
-Also, when using git manually, you must perform a manual sign-off to the
+Whenever pkgdev is not used to commit, you need to manually verify all
+packages affected by the commit using pkgcheck scan --commits. Also,
+when using git manually, you must perform a manual sign-off to the
using
the -s or --signoff option with your git commit commands. Make
sure you have read and understand the actual certificate.
@@ -224,8 +221,8 @@ appropriately:
-${CATEGORY}/${PN}: Single Package (Note that repoman commit
-and pkgdev commit will automatically insert this for you)
+${CATEGORY}/${PN}: Single Package (Note that pkgdev commit
+will automatically insert this for you)
${CATEGORY}: Package Category
profiles: Profile Directory
@@ -286,15 +283,11 @@ are optionally used in Gentoo:
referenced, it will be closed (as fixed) automatically with reference
to the commit.
-
-Package-Manager: This is automatically inserted by
-repoman
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: c305a14ac84919eb93abe6c7cc6da128c18ec4a5
Author: Sam James gentoo org>
AuthorDate: Sun Mar 13 01:46:26 2022 +
Commit: Sam James gentoo org>
CommitDate: Sun Mar 13 01:46:26 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c305a14a
quickstart: make blocker non-pure-DEPEND
Blockers need to be in RDEPEND too, per
devmanual guidance :)
Signed-off-by: Sam James gentoo.org>
quickstart/text.xml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/quickstart/text.xml b/quickstart/text.xml
index caff4e5..9847477 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -320,7 +320,7 @@ replacement iconv for libc implementations which
don't have their own.
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
EAPI=8
@@ -334,7 +334,8 @@ SLOT="0"
KEYWORDS="~amd64 ~ppc ~sparc ~x86"
IUSE="nls"
-DEPEND="!sys-libs/glibc"
+RDEPEND="!sys-libs/glibc"
+DEPEND="${RDEPEND}"
src_configure() {
econf $(use_enable nls)
[gentoo-commits] proj/devmanual:master commit in: general-concepts/projects/
commit: e203df7c6f481745aebf350d95dd9dff83e19237 Author: Sam James gentoo org> AuthorDate: Tue Feb 22 07:15:54 2022 + Commit: Sam James gentoo org> CommitDate: Thu Mar 10 23:32:57 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e203df7c general-concepts/projects: mention IRC channels Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/272 Signed-off-by: Sam James gentoo.org> general-concepts/projects/text.xml | 6 ++ 1 file changed, 6 insertions(+) diff --git a/general-concepts/projects/text.xml b/general-concepts/projects/text.xml index 32d5646..1282025 100644 --- a/general-concepts/projects/text.xml +++ b/general-concepts/projects/text.xml @@ -76,6 +76,12 @@ modifying the member list. It is standard however to consult the project lead. + +If the project has an official IRC channel listed on its project page, +developers should join the channel if possible to facilitate +coordination and collaboration. + + Developers should remember to add themselves to the alias by editing /var/mail/alias/misc/alias name on
[gentoo-commits] proj/devmanual:master commit in: general-concepts/projects/
commit: 70113f28b1525d9b55feed7b127afe445106b6c6 Author: Sam James gentoo org> AuthorDate: Tue Feb 22 07:14:56 2022 + Commit: Sam James gentoo org> CommitDate: Thu Mar 10 23:32:52 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=70113f28 general-concepts/projects: consult project lead on joining Signed-off-by: Sam James gentoo.org> general-concepts/projects/text.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/general-concepts/projects/text.xml b/general-concepts/projects/text.xml index c0a28ca..32d5646 100644 --- a/general-concepts/projects/text.xml +++ b/general-concepts/projects/text.xml @@ -72,7 +72,8 @@ lists the members of the project. Simply modifying the list is sufficient for adding or removing a developer. Note that different projects have different requirements and procedures for recruiting developers, which may require prior arrangements to be made before -modifying the member list. +modifying the member list. It is standard however to consult +the project lead.
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 876646b9ee6fa84f3ed8d225e7ba3442d2da338d Author: Sam James gentoo org> AuthorDate: Mon Jan 24 04:20:59 2022 + Commit: Sam James gentoo org> CommitDate: Thu Mar 10 23:33:17 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=876646b9 keywording: it's preferred to rekeyword packages with new deps It's preferred to rekeyword packages with their new dependencies in the same bug rather than using `package.use.mask` as this means the new code path(s) using the new dependencies get tested rather than just the new package/dependency in isolation. Also, no tooling exists for arch testers to automatically remove the relevant mask(s) once keywording is done, so often we end up with stale unnecessary masks remaining in tree. Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/270 Signed-off-by: Sam James gentoo.org> keywording/text.xml | 10 ++ 1 file changed, 10 insertions(+) diff --git a/keywording/text.xml b/keywording/text.xml index f794722..baffaaa 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -239,6 +239,16 @@ with repoman or pkgdev instead please commit with git commit message. + +Note that it is preferred to drop keywords on the package and request +rekeywording of it together with its new dependencies within the same bug to +allow the new code path(s) in your package to be tested. This won't happen if +the new dependency is requested for keywording by itself and +package.use.mask is used to mask the relevant new USE flag: only the +new package dependency will be tested by arch testers. Also, the mask has to be +manually removed during the testing process, which is cumbersome. + + When committing, make sure that you reference any bugs in the commit message. See for how
[gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
commit: 6756801c7f1d3b8a6326567a164891333b1f10d3
Author: Thomas Bracht Laumann Jespersen laumann xyz>
AuthorDate: Thu Jan 27 09:39:43 2022 +
Commit: Sam James gentoo org>
CommitDate: Tue Mar 1 09:58:56 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6756801c
general-concepts/autotools: Remove comment re einfo
In commit d9e28f40be32f76224ef0dbe2f3163e0615896f1, einfo lines were
removed from the examples but a paragraph still still referenced it.
Delete the paragraph.
Closes: https://bugs.gentoo.org/832156
Signed-off-by: Thomas Bracht Laumann Jespersen laumann.xyz>
Signed-off-by: Sam James gentoo.org>
general-concepts/autotools/text.xml | 7 ---
1 file changed, 7 deletions(-)
diff --git a/general-concepts/autotools/text.xml
b/general-concepts/autotools/text.xml
index 11cacf3..c4abdd4 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -141,13 +141,6 @@ src_configure() {
}
-
-The einfo message before running autotools is not mandatory. However,
these
-steps can sometimes take a while and may produce no output, so it may make
sense
-to let the user know that something is still happening. See
-.
-
-
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/
commit: e36a0545130215a7390dabaa5540d54c3a153c3f Author: Sam James gentoo org> AuthorDate: Fri Feb 25 19:02:45 2022 + Commit: Sam James gentoo org> CommitDate: Fri Feb 25 19:02:45 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e36a0545 ebuild-writing/eapi: update link to Python guide Migrated to projects.gentoo.org. Signed-off-by: Sam James gentoo.org> ebuild-writing/eapi/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index fbf88a5..2a716ae 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -80,7 +80,7 @@ or its dependencies. The Base System project has https://wiki.gentoo.org/wiki/Project:Base#Rules_and_limitations;>rules governing their use of newer EAPIs, as does the -https://dev.gentoo.org/~mgorny/python-guide/package-maintenance.html#porting-packages-to-a-new-eapi;>Python project. +https://projects.gentoo.org/python/guide/package-maintenance.html#porting-packages-to-a-new-eapi;>Python project.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/
commit: 57ba0f67f138341373555447371bd125e34e5b1c Author: Sam James gentoo org> AuthorDate: Mon Jan 10 01:20:35 2022 + Commit: Sam James gentoo org> CommitDate: Tue Feb 22 07:11:24 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=57ba0f67 ebuild-writing/eapi: document upgrade path policy The "upgrade path" policy is not particularly well-defined; over the years, various people have come to understand it as "two years", "one year", with mixed interpretations within that (is it enough to be able to upgrade just Portage?) This is a start towards formalising policy here, even if we end up changing it later, at least it's codified. Closes: https://bugs.gentoo.org/821553 Signed-off-by: Sam James gentoo.org> ebuild-writing/eapi/text.xml | 21 + 1 file changed, 21 insertions(+) diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index e85a3ec..257232c 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -62,8 +62,29 @@ EAPI-conditional code) When writing new ebuilds developers can choose whatever EAPI they think is the best. Using the features of the latest EAPI is encouraged. + + + +Upgrade path + + + +Gentoo policy is to support upgrades for installations at least a year old +with no/little intervention and up to two years old with minor intervention. To +achieve this, developers must avoid using the latest EAPI in ebuilds within +the @system set (see ) +or its dependencies. + + + +The Base System project has +https://wiki.gentoo.org/wiki/Project:Base#Rules_and_limitations;>rules +governing their use of newer EAPIs, as does the +https://dev.gentoo.org/~mgorny/python-guide/package-maintenance.html#porting-packages-to-a-new-eapi;>Python project. + +
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/eapi/
commit: 9db2bfb9151258ce62a1854774a6d3bf60734af2 Author: Sam James gentoo org> AuthorDate: Mon Jan 10 01:25:20 2022 + Commit: Sam James gentoo org> CommitDate: Tue Feb 22 07:11:27 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9db2bfb9 ebuild-writing/eapi: mention blocker retention period Bug: https://bugs.gentoo.org/821553 Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/261 Signed-off-by: Sam James gentoo.org> ebuild-writing/eapi/text.xml | 9 + 1 file changed, 9 insertions(+) diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index 257232c..fbf88a5 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -83,6 +83,15 @@ governing their use of newer EAPIs, as does the https://dev.gentoo.org/~mgorny/python-guide/package-maintenance.html#porting-packages-to-a-new-eapi;>Python project. + +It is also convention that blockers within ebuilds are retained for at least +2 years after the last ebuild matching the block is removed from the tree to +avoid file collisions for users upgrading older systems. pkgcheck has +a warning for this called OutdatedBlocker (or even +NonexistentBlocker for when the match is from pre-git times if using +a non-grafted repository). + +
[gentoo-commits] proj/devmanual:master commit in: general-concepts/use-flags/
commit: 3f0133a1c35420f3b67284e672538699a35c59fd Author: Sam James gentoo org> AuthorDate: Fri Jan 21 19:01:07 2022 + Commit: Sam James gentoo org> CommitDate: Mon Feb 21 21:39:53 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3f0133a1 general-concepts/use-flags: give guidance on IUSE defaults Avoid e.g. missing common functionality which upstream documentation may refer to/assume. Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/265 Signed-off-by: Sam James gentoo.org> general-concepts/use-flags/text.xml | 12 1 file changed, 12 insertions(+) diff --git a/general-concepts/use-flags/text.xml b/general-concepts/use-flags/text.xml index 02f1788..0605e91 100644 --- a/general-concepts/use-flags/text.xml +++ b/general-concepts/use-flags/text.xml @@ -203,6 +203,18 @@ Add + or - before the name of the use flag in IUSE to turn it on or off by default. + +IUSE defaults should be used sparingly. Reasons to exclude/default-disable a +feature may include e.g. large build time for a dependency, or a +configuration that the Gentoo maintainer is unable to test at runtime. + + + +The IUSE defaults for a package should not leave a package in a non-functional +state or lacking important, common functionality. Consulting upstream +documentation may be useful for assessing this. + + Adding - before a flag in IUSE is pretty much useless, as it will neither override the user configuration (make.conf) nor the profile
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: 5ef9e1d93aad7538c0c30cd076e956c2947ef4d8 Author: Florian Schmaus gentoo org> AuthorDate: Thu Dec 23 19:17:28 2021 + Commit: Sam James gentoo org> CommitDate: Mon Feb 21 05:21:44 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5ef9e1d9 general-concepts/dependencies: improve explaination of slot operators The section previously had hard to parse sentences like "[…] and that your package should be rebuilt if the version best matching the runtime dependency is updated to a version with a different slot or subslot" for the := operator. This commit attempts to improve the readability of the section. The change superseeds my proposed change in bug #739858. Thanks to Sam James for reviewing this. :) Signed-off-by: Florian Schmaus gentoo.org> Bug: https://bugs.gentoo.org/739858 Closes: https://github.com/gentoo/devmanual/pull/259 Signed-off-by: Sam James gentoo.org> general-concepts/dependencies/text.xml | 17 + 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index 1abebc8..ef27ac2 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -387,18 +387,19 @@ or sub-slot: -:= means that any slot is acceptable, and that your package should be -rebuilt if the version best matching the runtime dependency is updated to a -version with a different slot or subslot; +:= means that any slot is acceptable. Additionally indicates that +your package should be rebuilt if the version best matching the runtime +dependency is updated to a version with a different slot or subslot. -:* means that any slot is acceptable, and explicitly declares that -changes in the slot or sub-slot can be ignored; +:* means that any slot is acceptable. Furthermore, this slot +operator explicitly declares that changes in the slot or sub-slot can be +ignored. -:SLOT= means that only the 'SLOT' slot is acceptable, and that your -package should be rebuilt if the version matching the runtime dependency is -updated to another version with this slot but with a different subslot; +:SLOT= means that only the 'SLOT' slot is acceptable. It otherwise +behaves identically to the := operator. That is, the package must be +rebuilt if the sub-slot of the dependency changes. :SLOT means that only the 'SLOT' slot is acceptable, and that changes
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: a4828a6aeeae3b413ecce168b427122cc693f887 Author: Florian Schmaus gentoo org> AuthorDate: Thu Dec 23 19:10:36 2021 + Commit: Sam James gentoo org> CommitDate: Mon Feb 21 05:21:40 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a4828a6a general-concepts/dependencies: indent xml for better raw readability This is scavenged from my proposed change for bug #739858. Signed-off-by: Florian Schmaus gentoo.org> Bug: https://bugs.gentoo.org/739858 Signed-off-by: Sam James gentoo.org> general-concepts/dependencies/text.xml | 36 ++ 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index a3ea540..1abebc8 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -386,19 +386,29 @@ or sub-slot: - := means that any slot is acceptable, and that your package should be - rebuilt if the version best matching the runtime dependency is updated to a - version with a different slot or subslot; - :* means that any slot is acceptable, and explicitly declares that - changes in the slot or sub-slot can be ignored; - :SLOT= means that only the 'SLOT' slot is acceptable, and that your - package should be rebuilt if the version matching the runtime dependency is - updated to another version with this slot but with a different subslot; - :SLOT means that only the 'SLOT' slot is acceptable, and that changes - in the sub-slot can be ignored (like in previous EAPIs). - :SLOT/SUBSLOT means a dependency on a specific slot and sub-slot pair, - which can be useful for packages installing pre-built binaries that require a - library with a particular soname version corresponding to the sub-slot. + +:= means that any slot is acceptable, and that your package should be +rebuilt if the version best matching the runtime dependency is updated to a +version with a different slot or subslot; + + +:* means that any slot is acceptable, and explicitly declares that +changes in the slot or sub-slot can be ignored; + + +:SLOT= means that only the 'SLOT' slot is acceptable, and that your +package should be rebuilt if the version matching the runtime dependency is +updated to another version with this slot but with a different subslot; + + +:SLOT means that only the 'SLOT' slot is acceptable, and that changes +in the sub-slot can be ignored (like in previous EAPIs). + + +:SLOT/SUBSLOT means a dependency on a specific slot and sub-slot pair, +which can be useful for packages installing pre-built binaries that require a +library with a particular soname version corresponding to the sub-slot. +
[gentoo-commits] proj/devmanual:master commit in: archs/sparc/
commit: f0be5cfbd0fe4f62fe0ee70abef4044247984a7b Author: Sam James gentoo org> AuthorDate: Sat Jan 22 20:48:47 2022 + Commit: Sam James gentoo org> CommitDate: Mon Feb 21 05:15:25 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f0be5cfb archs/sparc: mention SIGBUS/unaligned access and link to tracker bug Bug: https://bugs.gentoo.org/371525 Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/266 Signed-off-by: Sam James gentoo.org> archs/sparc/text.xml | 14 ++ 1 file changed, 14 insertions(+) diff --git a/archs/sparc/text.xml b/archs/sparc/text.xml index 20ce4b8..2b00f54 100644 --- a/archs/sparc/text.xml +++ b/archs/sparc/text.xml @@ -10,6 +10,20 @@ hardware (Sun UltraSparc systems with v9 CPUs). v8 processors and 2.4 kernels should still work with Gentoo, but they are no longer supported by the Gentoo/SPARC team. + + +SPARC systems are notoriously strict on aligned access: this is the most common +type of bug seen on SPARC (other than big-endian related issues), causing a +SIGBUS signal to be sent to the errant process. Known issues should be +linked to +https://bugs.gentoo.org/371525;>the related tracker bug. + + + +This is usually due to supposedly clever pointer casts and type punning tricks +by the code authors. + +
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: 35b8e9ef476c31fdcaf58291e2d158e62f89616d Author: Sam James gentoo org> AuthorDate: Sat Jan 22 23:31:33 2022 + Commit: Sam James gentoo org> CommitDate: Fri Feb 18 18:19:19 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=35b8e9ef ebuild-maintenance/package-moves: link to updates/ page Bug: https://bugs.gentoo.org/388685 Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/268 Signed-off-by: Sam James gentoo.org> ebuild-maintenance/package-moves/text.xml | 7 --- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index 4180c17..c5b278f 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -12,9 +12,10 @@ the following must be noted: -Updates are not one-shot operations and they are not stateful. All -updates can be reapplied multiple times to the same system, and all old -updates are applied to fresh Gentoo installations. +Updates are not one-shot +operations and they are not stateful. All updates can be reapplied multiple +times to the same system, and all old updates are applied to fresh Gentoo +installations. Once an update entry is created, the old package name (or slot) cannot be
[gentoo-commits] proj/devmanual:master commit in: general-concepts/portage-cache/
commit: 5e91e851b96bc43a952870403194abcd7d7c52dd Author: Sam James gentoo org> AuthorDate: Mon Jan 24 04:15:19 2022 + Commit: Sam James gentoo org> CommitDate: Fri Feb 18 18:19:24 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5e91e851 general-concepts/portage-cache: add "metadata invariance" term Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/269 Signed-off-by: Sam James gentoo.org> general-concepts/portage-cache/text.xml | 5 + 1 file changed, 5 insertions(+) diff --git a/general-concepts/portage-cache/text.xml b/general-concepts/portage-cache/text.xml index a1394af..857cf6b 100644 --- a/general-concepts/portage-cache/text.xml +++ b/general-concepts/portage-cache/text.xml @@ -11,6 +11,11 @@ these variables must be either static or generated using only unchanging 'version / name' variables (P, PN, PV, PR, PVR and PF). + +The cache, when generated, must be identical independent of the used machine +or environment. This concept is referred to as metadata invariance. + + So, the following will not work:
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: 1c2f5ca517d0dfa40b81871060b6b17f0e9acdf1 Author: Sam James gentoo org> AuthorDate: Sat Jan 22 23:29:48 2022 + Commit: Sam James gentoo org> CommitDate: Fri Feb 18 18:19:15 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1c2f5ca5 ebuild-writing/variables: link to package/slot move page in SLOT Closes: https://bugs.gentoo.org/388685 Signed-off-by: Sam James gentoo.org> ebuild-writing/variables/text.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 9b2db1f..f07832e 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -360,7 +360,8 @@ When slots are not needed, use SLOT="0". Do not use -See for more information on this variable. +See for more information on this +variable and see .
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 17ea5e4be826a1155ddc62ce4dbbccb7d26eba15 Author: Sam James gentoo org> AuthorDate: Sat Jan 22 23:24:54 2022 + Commit: Sam James gentoo org> CommitDate: Fri Feb 18 18:19:34 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=17ea5e4b keywording: note that stabilization rules are for actual testing These rules are for maintainers wishing to stable if they have access to hardware -- they do _not_ mean maintainers must follow these rules just to file a bug and stabilise a package via CCing arch teams (the usual route). Closes: https://bugs.gentoo.org/546942 Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/267 Signed-off-by: Sam James gentoo.org> keywording/text.xml | 5 + 1 file changed, 5 insertions(+) diff --git a/keywording/text.xml b/keywording/text.xml index 732271f..f794722 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -379,6 +379,11 @@ Vulnerability Treatment Policy. Stabilization rules + +These are rules for stabilizing packages by yourself on a particular +architecture, not for filing bugs to request arch teams to handle it. + + amd64, x86: If you are the maintainer of a package and own
[gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
commit: ece9a5736c0a04daa7d03738a9b2624f088f85fa Author: Ulrich Müller gentoo org> AuthorDate: Wed Feb 16 18:54:40 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Feb 16 18:54:40 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ece9a573 appendices/devbook-guide: Indent the table properly The style guide should follow the style guide. :) Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 52 +++ 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index e233e21..f9a6b5a 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -359,32 +359,32 @@ right-aligned, left-aligned or centered with the align attribute. - -This title spans 4 columns - - -This title spans 6 rows -Item A1 -Item A2 -Item A3 - - -Item B1 -Blocky 2x2 title - - -Item C1 - - -Item D1..D3 - - -Item E1..F1 -Item E2..E3 - - -Item F2..F3 - + + This title spans 4 columns + + + This title spans 6 rows + Item A1 + Item A2 + Item A3 + + + Item B1 + Blocky 2x2 title + + + Item C1 + + + Item D1..D3 + + + Item E1..F1 + Item E2..E3 + + + Item F2..F3 +
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: 9d82f20f7c579ac558f1179af8d332f763862728 Author: Ulrich Müller gentoo org> AuthorDate: Wed Feb 16 18:42:28 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Feb 16 18:42:28 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9d82f20f ebuild-writing/variables: Whitespace Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/variables/text.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 41976b2..9b2db1f 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -488,7 +488,6 @@ list does not outweigh the burden of maintaining it. - Lifting restrictions
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/variables/
commit: aec6c83e31a883f9777198b45e8356660afb35d4
Author: Matthew Smith gentoo org>
AuthorDate: Tue Feb 15 20:11:08 2022 +
Commit: Matthew Smith gentoo org>
CommitDate: Wed Feb 16 18:02:16 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=aec6c83e
ebuild-writing/variables: Selectively lifting SRC_URI restrictions
Closes: https://github.com/gentoo/devmanual/pull/271
Signed-off-by: Matthew Smith gentoo.org>
ebuild-writing/variables/text.xml | 62 ++-
1 file changed, 61 insertions(+), 1 deletion(-)
diff --git a/ebuild-writing/variables/text.xml
b/ebuild-writing/variables/text.xml
index e45794d..41976b2 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -431,7 +431,6 @@ SRC_URI="https://example.com/files/${PV}.tar.gz -
${P}.tar.gz"
-
Third-party mirrors
@@ -486,6 +485,67 @@ infrastructure; in that case, the benefit to using
third-party mirror
list does not outweigh the burden of maintaining it.
+
+
+
+
+
+Lifting restrictions
+
+
+
+In EAPI 8, individual items in SRC_URI can be exempted from automatic
+mirroring and fetching restrictions (imposed by RESTRICT="mirror" and
+RESTRICT="fetch") by prefixing the addresses with mirror+ or
+fetch+. For example, in the following ebuild,
+
+
+
+EAPI="8"
+
+SRC_URI="${P}.tar.gz
+ mirror+https://dev.gentoo.org/~larry/distfiles/${P}-addons.tar.gz;
+
+RESTRICT="fetch"
+
+
+
+Portage will be prevented from trying to fetch ${P}.tar.gz as expected,
+but the ${P}-patches.tar.gz file will be mirrored and fetched by Portage
+without restriction.
+
+
+
+The following table shows the effects of the prefixes when
RESTRICT="mirror" and RESTRICT="fetch" are set:
+
+
+
+
+
+ (no prefix)
+ fetch+
+ mirror+
+
+
+ (no RESTRICT)
+ fetch mirror
+ fetch mirror
+ fetch mirror
+
+
+ RESTRICT="mirror"
+ fetch only
+ fetch only
+ fetch mirror
+
+
+ RESTRICT="fetch"
+ unfetchable
+ fetch only
+ fetch mirror
+
+
+
[gentoo-commits] proj/devmanual:master commit in: /
commit: 6ef11f64a2d763360542bd6a3c74da46f15dfa23
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Jan 16 21:59:15 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Mon Jan 24 18:16:10 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6ef11f64
devbook.rnc: Change from DTD to RELAX NG compact schema
The currently used DTD format has several limitations. It does not
support data types, and it is not expressive enough for some element
syntax used in the devmanual. For example, it cannot accurately
describe the uri element which comes in two alternative forms
(namely, with the link in its body text or as an attribute).
RELAX NG is chosen because it has a variant with a compact and very
readable non-XML syntax, and it is well supported both as an input and
as an output format by conversion tools like app-text/trang. Also, we
need RNC for app-emacs/nxml-gentoo-schemas anyway.
devbook.rnc is the source file, but the generated devbook.rng is also
committed to the repository, in order to avoid an additional
dependency on trang or rnc2rng.
Signed-off-by: Ulrich Müller gentoo.org>
Makefile| 10 +-
devbook.dtd | 94 ---
devbook.rnc | 113 ++
devbook.rng | 391
4 files changed, 512 insertions(+), 96 deletions(-)
diff --git a/Makefile b/Makefile
index 2c7952a..cbb31e7 100644
--- a/Makefile
+++ b/Makefile
@@ -82,10 +82,16 @@ install: all
install -m 644 $(JS_FILES) "$(DESTDIR)$(htmldir)"/; \
fi
-validate:
- @xmllint --noout --dtdvalid devbook.dtd $(XMLS)
+# 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)
@echo "xmllint validation successful"
+%.rng: %.rnc
+ trang $< $@
+ sed -i -e '2s/^/\n/' $@
+
# Run app-text/htmltidy on the output to detect mistakes.
# We have to loop through them because otherwise tidy won't
# tell you which file contains a mistake.
diff --git a/devbook.dtd b/devbook.dtd
deleted file mode 100644
index 77ba737..000
--- a/devbook.dtd
+++ /dev/null
@@ -1,94 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/devbook.rnc b/devbook.rnc
new file mode 100644
index 000..4ca931d
--- /dev/null
+++ b/devbook.rnc
@@ -0,0 +1,113 @@
+# Copyright 2022 Gentoo Authors
+# Distributed under the terms of the MIT license
+# or the CC-BY-SA-4.0 license (dual-licensed)
+
+# RELAX NG schema for the Gentoo Devmanual
+# Based on common.dtd from GuideXML
+
+block.class = p | pre | codesample | note | important | warning | todo
+| figure | table | ul | ol | dl
+attrib.class = text | b | c | e
+inline.class = attrib.class | d | uri
+
+attrib = attrib.class*
+inline = inline.class*
+all = (block.class | inline.class)*
+
+start = guide
+
+guide = element guide {
+ (attribute root { "true" } | attribute self { text }),
+ chapter,
+ \include*
+}
+
+\include = element include { attribute href { text } }
+
+chapter = element chapter { title, (body | section), section* }
+section = element section { title, (body | subsection), subsection* }
+subsection =
+ element subsection { title, (body | subsubsection), subsubsection* }
+subsubsection = element subsubsection { title, body }
+
+# Title texts are used as anchors, so allow only text attributes
+title = element title { attrib }
+
+body = element body { (authors | contentsTree | block.class)+ }
+
+authors = element authors { author+ | authorlist+ }
+
+author = element author {
+ attribute name { text },
+ attribute email { text }?,
+ inline
+}
+
+authorlist = element authorlist {
+ attribute title { text },
+ attribute href { text }
+}
+
+contentsTree = element contentsTree {
+ attribute maxdepth { xsd:unsignedInt }?,
+ attribute root { text }?,
+ attribute extraction { text }?
+}
+
+p = element p { inline }
+
+pre = element pre { text }
+
+codesample = element codesample {
+ attribute lang { "c" | "ebuild" | "make" | "m4" | "sgml" },
+ attribute numbering { "lines" }?,
+ text
+}
+
+note = element note { inline }
+important = element important { inline }
+warning = element warning { inline }
+todo = element todo { inline }
+
+figure = element figure {
+ attribute link { text },
+ attribute short { text }?,
+ attribute caption { text }?
+}
+
+table = element table { tr+ }
+tr = element tr { (th | ti)+ }
+
+th = element th {
+ attribute colspan { xsd:unsignedInt }?,
+ attribute rowspan { xsd:unsignedInt }?,
+ attribute align { "left" | "center" | "right" }?,
+ inline
+}
+
+ti = element ti {
+ attribute colspan { xsd:unsignedInt }?,
+ attribute rowspan { xsd:unsignedInt }?,
+ attribute nowrap { "nowrap" }?,
+ attribute align { "left" | "center" | "right" }?,
+
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
commit: 1827baaac60d39987c44a791fde73b186c19844f Author: Sam James gentoo org> AuthorDate: Sat Jan 22 23:41:34 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 23:43:45 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1827baaa ebuild-writing/common-mistakes: .diff -> .patch We usually use .patch nowadays so reflect that in the docs. Signed-off-by: Sam James 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 4e26462..63c44d3 100644 --- a/ebuild-writing/common-mistakes/text.xml +++ b/ebuild-writing/common-mistakes/text.xml @@ -607,7 +607,7 @@ The best way to generate it would be: -$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild ~/some-package-0.2.0.diff +$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild ~/some-package-0.2.0.patch
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/new-ebuild/
commit: e7c201902967728dffa91c9cca11c5896e15c98c Author: Sam James gentoo org> AuthorDate: Sat Jan 22 23:39:42 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 23:40:54 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e7c20190 ebuild-maintenance/new-ebuild: use .patch, not .diff We almost always use .patch now, so let's just reference it here too. Signed-off-by: Sam James gentoo.org> ebuild-maintenance/new-ebuild/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ebuild-maintenance/new-ebuild/text.xml b/ebuild-maintenance/new-ebuild/text.xml index 7ef8254..eebdb8d 100644 --- a/ebuild-maintenance/new-ebuild/text.xml +++ b/ebuild-maintenance/new-ebuild/text.xml @@ -101,8 +101,8 @@ this directory; any files bigger than 20KB-or-so should go to the mirrors to lower the amount of (unneeded) files our users have to download. You may want to consider naming patches you create yourself just to get your package to build with a version-specific name, such -as mypkg-1.0-gentoo.diff, or more -simply, 1.0-gentoo.diff. Also note that the +as mypkg-1.0-gentoo.patch, or more +simply, 1.0-gentoo.patch. Also note that the gentoo extension informs people that this patch was created by us, the Gentoo Linux developers, rather than having been grabbed from a mailing list or somewhere else. Again, you should not compress these
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 5ef0611901e3ef14e6473c960418985f6b6f7c61 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:36:03 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 21:34:56 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5ef06119 keywording: mention filing bugs for package.mask entries It's useful to have a bug filed for things masked for testing / due to breakages so that feedback can be gathered in one place / the relevant issue can be debugged. We've sometimes had things p.masked indefinitely for "testing" when it's not clear exactly what needs to be done left, or due to a "bug" which with few details cannot be reproduced some time later. Bug: https://bugs.gentoo.org/705394 Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/262 Signed-off-by: Sam James gentoo.org> keywording/text.xml | 6 ++ 1 file changed, 6 insertions(+) diff --git a/keywording/text.xml b/keywording/text.xml index 1398ca7..732271f 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -138,6 +138,12 @@ which are not hard masked must not have a dependency upon hard masked packages. + +It is good practice to file a bug for ebuilds listed in package.mask to +allow feedback to be gathered in one location and to reduce the chance of +forgetting about it. Mention the bug number in the mask message. + + The only time it is acceptable for a user to see the Possibly a DEPEND problem error message is if they have manually changed visibility levels for
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: d3dbd7ea0bd09daf0c9daf790d50952244b62b0a
Author: Sam James gentoo org>
AuthorDate: Wed Jan 12 04:31:49 2022 +
Commit: Sam James gentoo org>
CommitDate: Sat Jan 22 21:34:55 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d3dbd7ea
keywording: add note about `repoman commit --straight-to-stable`
Somewhat regularly see --force being used with repoman commit rather
than --straigh-to-stable.
--straight-to-stable is preferable if it must be done because it
doesn't disable repoman's other QA checks.
Signed-off-by: Sam James gentoo.org>
keywording/text.xml | 5 -
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/keywording/text.xml b/keywording/text.xml
index ed6b6d1..1398ca7 100644
--- a/keywording/text.xml
+++ b/keywording/text.xml
@@ -189,7 +189,10 @@ a dependency of a package already keyworded.
-Do not commit straight to arch ("stable").
+Do not commit straight to arch ("stable"). If it is necessary
+to do so, when using repoman, use
+repoman commit --straight-to-stable and not --force as
+this disables other QA checks.
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: 20a8ffa9fdd1b9f30fd99346dc6c9f876a4af5f0 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:44:11 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 21:34:47 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=20a8ffa9 ebuild-maintenance/package-moves: minor grammar and formatting nits - Drop a comma - Use SLOT Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/260 Signed-off-by: Sam James gentoo.org> ebuild-maintenance/package-moves/text.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index 206436b..4180c17 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -47,7 +47,7 @@ the package. Afterwards, move the package files using git mv. Add the move entry -to profiles/updates/, in the following format: +to profiles/updates/ in the following format: @@ -96,8 +96,8 @@ 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 +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:
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: 986ca8f1dd6eca7c9a1b099a9a652bc9710786b1
Author: Sam James gentoo org>
AuthorDate: Sat Jan 1 11:15:26 2022 +
Commit: Sam James gentoo org>
CommitDate: Sat Jan 22 21:34:45 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=986ca8f1
ebuild-maintenance/package-moves: add common terms for pkgmove/slotmove
Signed-off-by: Sam James gentoo.org>
ebuild-maintenance/package-moves/text.xml | 15 ---
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/ebuild-maintenance/package-moves/text.xml
b/ebuild-maintenance/package-moves/text.xml
index 21cd245..93e0dcf 100644
--- a/ebuild-maintenance/package-moves/text.xml
+++ b/ebuild-maintenance/package-moves/text.xml
@@ -35,12 +35,13 @@ the following must be noted:
-Moving or renaming a package requires several operations. Firstly, verify that
-the ebuilds will continue to work correctly after the move. If the category
-changes, you must verify all ${CATEGORY} uses. If the package name
-changes, you must verify ${PN}, ${P}, etc. Whenever the old value
-is necessary, substitute the variable reference with the verbatim text, so that
-it won't get affected by the move. Commit the changes separately before moving
+Moving or renaming a package (sometimes called a "pkgmove" or just "move")
+requires several operations. Firstly, verify that the ebuilds will continue to
+work correctly after the move. If the category changes, you must verify all
+${CATEGORY} uses. If the package name changes, you must verify
+${PN}, ${P}, etc. Whenever the old value is necessary,
+substitute the variable reference with the verbatim text, so that it won't get
+affected by the move. Commit the changes separately before moving
the package.
@@ -92,7 +93,7 @@ during the update.
-The process for changing the ebuild's SLOT is very similar to the
+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:
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: ad87b9249ca686eee537e76d0bb6916ef22d9aa2 Author: Sam James gentoo org> AuthorDate: Sat Jan 1 11:17:31 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 21:34:46 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ad87b924 ebuild-maintenance/package-moves: mention optfeature Signed-off-by: Sam James gentoo.org> ebuild-maintenance/package-moves/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index dc9fc6b..206436b 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -62,8 +62,8 @@ and update them. These include: dependencies, -has_version and best_version uses in other ebuilds -and eclasses +optfeature.eclass uses, has_version and best_version +uses in other ebuilds and eclasses all profiles/ tree entries (e.g. profiles/package.mask)
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/package-moves/
commit: dc5767a0404c1d60e67352202953d88931a6cedc Author: Sam James gentoo org> AuthorDate: Sat Jan 1 11:16:30 2022 + Commit: Sam James gentoo org> CommitDate: Sat Jan 22 21:34:45 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dc5767a0 ebuild-maintenance/package-moves: mention updating wiki pages Signed-off-by: Sam James gentoo.org> ebuild-maintenance/package-moves/text.xml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index 93e0dcf..dc9fc6b 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -78,6 +78,9 @@ and update them. These include: open bug summaries + +wiki pages +
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: e61cbdca52edcc1ff6bac20577722793703997ce
Author: Sam James gentoo org>
AuthorDate: Wed Jan 12 04:26:44 2022 +
Commit: Sam James gentoo org>
CommitDate: Sat Jan 22 21:34:54 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e61cbdca
keywording: add explanatory text on maintainer obligations
Inspired partly by a discussion on a GitHub pull request [0].
[0] https://github.com/gentoo/gentoo/pull/23735
Signed-off-by: Sam James gentoo.org>
keywording/text.xml | 23 +++
1 file changed, 23 insertions(+)
diff --git a/keywording/text.xml b/keywording/text.xml
index cc10166..ed6b6d1 100644
--- a/keywording/text.xml
+++ b/keywording/text.xml
@@ -243,6 +243,29 @@ to do this.
Moving from ~arch to arch
+
+If a package has stable keywords, maintainers should regularly (subject to the
+rules below) file stabilization bugs for their packages, ideally approximately
+every 30 days after a new version is added. If a bug report for stabilization
+is filed by somebody else, the maintainer should respond with an
+acknowledgement ("ACK") if the ebuild is ready, and a negative
+acknowledgement ("NAK") if not.
+
+
+
+Previous stable keywords should not be dropped without good cause and it is
+courteous to ping members of the relevant arch team first. Maintainers must not
+drop stable keywords simply because they don't have access to a platform: this
+is what Gentoo's arch teams are here for.
+
+
+
+By convention, these bugs are assigned to package maintainers, but the only
+action expected from maintainers is to acknowledge or reject the
+stabilization rather than carry out additional testing on each required
+architecture themselves.
+
+
Stabilization, i.e., moving an ebuild from ~arch ("testing") to
arch ("stable"), is done by the relevant architecture teams. If you have
[gentoo-commits] proj/devmanual:master commit in: /
commit: ee1ca6dd07a2561d26029f4f0c1a5ef65160337e Author: Ulrich Müller gentoo org> AuthorDate: Tue Jan 18 19:33:51 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 19 11:26:03 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ee1ca6dd devbook.xsl: Support alignment of table cells The "align" attribute is documented in the DevBook XML Guide, but was not implemented in the XSL stylesheet. Signed-off-by: Ulrich Müller gentoo.org> devbook.xsl | 26 +- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/devbook.xsl b/devbook.xsl index 1ebbb3b..bf68e9a 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -82,9 +82,12 @@ - - - white-space: + + + +white-space:; +text-align:; + @@ -95,16 +98,21 @@ - - text-align:center + + +text-align:; + + + +text-align:center; + +
[gentoo-commits] proj/devmanual:master commit in: function-reference/install-functions/
commit: 59830bf240718914323abcd7e77260e7a2858080 Author: Ulrich Müller gentoo org> AuthorDate: Wed Dec 22 15:56:47 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Jan 17 16:52:09 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=59830bf2 function-reference/install-functions: be more specific about dobin location Bug: https://bugs.gentoo.org/586632 Suggested-by: Sebastian Pipping gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> function-reference/install-functions/text.xml | 7 --- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/function-reference/install-functions/text.xml b/function-reference/install-functions/text.xml index da2af83..fcb8941 100644 --- a/function-reference/install-functions/text.xml +++ b/function-reference/install-functions/text.xml @@ -103,9 +103,10 @@ The *into functions create the directory if it does not already exist. dobin - Install a binary into /usr/bin, set the file mode to 0755 - and set the ownership to superuser or its equivalent on the - system or installation at hand. + Install a binary into subdirectory bin of the location provided + by into (resulting in /usr/bin by default) with mode 0755 + and with ownership set to superuser or its equivalent on the system or + installation at hand
[gentoo-commits] proj/devmanual:master commit in: /
commit: dc82d8e45d48814b94458a3ce4edc396919a1d08
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Jan 16 21:49:28 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Jan 16 21:49:28 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dc82d8e4
Makefile: Simplify recipes for validate and tidy targets
Signed-off-by: Ulrich Müller gentoo.org>
Makefile | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Makefile b/Makefile
index 3409931..2c7952a 100644
--- a/Makefile
+++ b/Makefile
@@ -83,8 +83,8 @@ install: all
fi
validate:
- @xmllint --noout --dtdvalid devbook.dtd $(XMLS) \
- && echo "xmllint validation successful"
+ @xmllint --noout --dtdvalid devbook.dtd $(XMLS)
+ @echo "xmllint validation successful"
# Run app-text/htmltidy on the output to detect mistakes.
# We have to loop through them because otherwise tidy won't
@@ -96,8 +96,8 @@ tidy: $(HTMLS) $(ECLASS_HTMLS)
| tidy -q -errors --drop-empty-elements no 2>&1) \
|| { status=$$?; echo "Failed on $${f}:"; echo "$${output}"; }; \
done; \
- test $${status} -eq 0 && echo "tidy validation successful"; \
exit $${status}
+ @echo "tidy validation successful"
check: validate tidy
[gentoo-commits] proj/devmanual:master commit in: general-concepts/pic/
commit: 4a76428f91e009474ad60a0ee063a5d2ff0b678e Author: Sam James gentoo org> AuthorDate: Thu Jan 13 10:16:04 2022 + Commit: Sam James gentoo org> CommitDate: Thu Jan 13 10:16:58 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4a76428f general-concepts/pic: trivial grammar fix (+ "the") Reported-by: Louis Sautier gentoo.org> Signed-off-by: Sam James gentoo.org> general-concepts/pic/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/general-concepts/pic/text.xml b/general-concepts/pic/text.xml index 85c85c1..42a33a9 100644 --- a/general-concepts/pic/text.xml +++ b/general-concepts/pic/text.xml @@ -16,8 +16,8 @@ If you encounter a package that is not building shared libraries with -fPIC. More information on PIC is available at the https://wiki.gentoo.org/wiki/Project:Hardened/Position_Independent_Code_internals;> PIC internals wiki page. If you are unsure, please ask in a public -developer forum (like the gentoo-dev mailing list or #gentoo-dev -IRC channel) for help. +developer forum (like the gentoo-dev mailing list or the +#gentoo-dev IRC channel) for help.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/pic/
commit: ac1685616b88eaa2ea65ce9a708d659c79e2b903 Author: Ulrich Müller gentoo org> AuthorDate: Wed Jan 12 06:33:31 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:33:31 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ac168561 general-concepts/pic: Coding style Signed-off-by: Ulrich Müller gentoo.org> general-concepts/pic/text.xml | 18 ++ 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/general-concepts/pic/text.xml b/general-concepts/pic/text.xml index 44e97bd..85c85c1 100644 --- a/general-concepts/pic/text.xml +++ b/general-concepts/pic/text.xml @@ -2,14 +2,24 @@ Position Independent Code - + -On some architectures, shared libraries must be built with -fPIC. On x86 and others, shared libraries may build without -fPIC. This can be wasteful and potentially cause a performance hit. +On some architectures, shared libraries must be built with -fPIC. +On x86 and others, shared libraries may build without -fPIC. +This can be wasteful and potentially cause a performance hit. -If you encounter a package that is not building shared libraries with -fPIC, patch the Makefile to build only the shared libraries with -fPIC. More information on PIC is available at the https://wiki.gentoo.org/wiki/Project:Hardened/Position_Independent_Code_internals;>PIC internals wiki page. If you are unsure, please ask in a public developer forum (like the gentoo-dev mailing list or #gentoo-dev IRC channel) for help. + + +If you encounter a package that is not building shared libraries with +-fPIC, patch the Makefile to build only the shared libraries with +-fPIC. More information on PIC is available at the +https://wiki.gentoo.org/wiki/Project:Hardened/Position_Independent_Code_internals;> +PIC internals wiki page. If you are unsure, please ask in a public +developer forum (like the gentoo-dev mailing list or #gentoo-dev +IRC channel) for help. - +
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 434e6c60110c6bde6edbfd2081f2a6a913cb67e1 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 05:00:05 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:56 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=434e6c60 ebuild-writing/misc-files/metadata: fix formatting, use tags consistently Signed-off-by: Sam James gentoo.org> [Whitespace changes] Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 41 +++-- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index 416167c..a961821 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -132,7 +132,8 @@ metadata.xml: This tag describes the slots of a package. -It has two optional subtags: slot and subslots. +It has two optional subtags: +slot and subslots. @@ -172,17 +173,17 @@ metadata.xml: upstream This tag contains information about the upstream developers/project. -It supports multiple optional subtags: maintainer, -changelog, doc, bugs-to, -and remote-id. +It supports multiple optional subtags: maintainer, +changelog, doc, +bugs-to,, and remote-id. maintainer Provides information about the upstream maintainer. It requires a -name subtag to be specified, supports an optional -email subtag and an optional status attribute. +name subtag to be specified, supports an optional +email subtag and an optional status attribute. Note that the type attribute must not be specified for upstream maintainers. @@ -217,7 +218,7 @@ metadata.xml: found. The link must not point to any third party documentation and must be version independent. If the documentation is available in more than one language, a lang attribute can be used which follows the same rules as the one for -longdescription. +longdescription. @@ -301,12 +302,12 @@ There are also some attributes that can be used with these tags: flag, slot -When this attribute is required on the flag tag, it +When this attribute is required on the flag tag, it simply contains the name of the USE flag. For the -slot tag, it specifies the +slot tag, it specifies the slot name to which it applies. A slot name of * -allows for a single slot tag to match all the slots of a +allows for a single slot tag to match all the slots of a package, in which case no other slot tags may be present. @@ -320,7 +321,7 @@ There are also some attributes that can be used with these tags: one of "active" or "inactive". This attribute is not mandatory. The absence of it shall be interpreted as "unknown". Please note that this attribute is only allowed -for the maintainer subtags of the upstream +for the maintainer subtags of the upstream element! @@ -405,7 +406,7 @@ presented. It is a simplified version of metadata.xml for the package app-office/libreoffice. The package maintainer is identified by the email address off...@gentoo.org with the name Gentoo Office Project as specified in the -optional name subtag. It also provides a long package +optional name subtag. It also provides a long package description. @@ -470,9 +471,9 @@ The second example is formed after the metadata.xml of is a developer and the other is a project. It illustrates how local USE flag descriptions are specified and also contains an upstream element. It is also worth pointing out the use of mailto: -prefix in bugs-to tag due to the presence of an email address +prefix in bugs-to tag due to the presence of an email address as opposed to a URL. Conversely, email addresses specified in the -email tags require no such prefix. +email tags require no such prefix. @@ -524,9 +525,9 @@ project. Note the use of "gt;" as opposed to "" in The example also uses the pkg tag in USE flag descriptions. Slot dependency specifiers are not allowed inside -pkg, therefore the notation -pkgsys-boot/grub/pkg:2 is adopted as opposed to -pkgsys-boot/grub:2/pkg. +pkg, therefore the notation +pkgsys-boot/grub/pkg:2 is adopted as opposed to +pkgsys-boot/grub:2/pkg. @@ -635,9 +636,9 @@ specified in the subslots tag. Maintainer-needed, or orphaned, packages have no maintainers responsible for them. Per https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages;> -GLEP 67, these packages must not contain any maintainer -subtags under pkgmetadata in their metadata.xml. A strict test -for this condition would be: +GLEP 67, these packages must not contain any maintainer +subtags under pkgmetadata in their metadata.xml. A strict +test for this condition would be:
[gentoo-commits] proj/devmanual:master commit in: general-concepts/portage-cache/
commit: bd8a89afefff176b5f85a1e1e20632457994afd1 Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:50:00 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:55 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bd8a89af general-concepts/portage-cache: clarify phrasing (minor) Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> general-concepts/portage-cache/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/general-concepts/portage-cache/text.xml b/general-concepts/portage-cache/text.xml index 4839fa0..a1394af 100644 --- a/general-concepts/portage-cache/text.xml +++ b/general-concepts/portage-cache/text.xml @@ -25,8 +25,8 @@ fi -However, this is legal, since eapi7-ver.eclass works upon PV, and -PV and PN are both static: +However, the following is legal, since eapi7-ver.eclass works upon +PV, PV, and PN are both static:
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: 427ba55ed4af436ebf2a4dc420c5db77f7f3430c Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:52:02 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:55 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=427ba55e ebuild-writing/misc-files/metadata: use conventional metadata.xml tag ordering Matches other examples on the page too. Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/misc-files/metadata/text.xml | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index eb6551c..416167c 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -479,11 +479,6 @@ as opposed to a URL. Conversely, email addresses specified in the ?xml version="1.0" encoding="UTF-8"? !DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd"; pkgmetadata - upstream -bugs-tomailto:dev-port...@gentoo.org/bugs-to; - changeloghttps://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES/changelog; - dochttps://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage/doc; - /upstream maintainer type="person" emailla...@gentoo.org/email nameLarry the Cow/name @@ -502,6 +497,11 @@ as opposed to a URL. Conversely, email addresses specified in the installing files. Usually only required for hardened systems. /flag /use + upstream +bugs-tomailto:dev-port...@gentoo.org/bugs-to; + changeloghttps://gitweb.gentoo.org/proj/portage.git/plain/RELEASE-NOTES/changelog; + dochttps://wiki.gentoo.org/wiki/Handbook:AMD64/Working/Portage/doc; + /upstream /pkgmetadata
[gentoo-commits] proj/devmanual:master commit in: general-concepts/pic/
commit: 21ba10234bad70c26b9a9be864409b2758c8c7be Author: Sam James gentoo org> AuthorDate: Wed Jan 12 04:48:32 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Jan 12 06:28:54 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=21ba1023 general-concepts/pic: capitalise IRC; use tags on IRC channel/ML/arch name We use such tags elsewhere for IRC channels already. Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> general-concepts/pic/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/general-concepts/pic/text.xml b/general-concepts/pic/text.xml index 4c0613c..44e97bd 100644 --- a/general-concepts/pic/text.xml +++ b/general-concepts/pic/text.xml @@ -5,9 +5,9 @@ -On some architectures, shared libraries must be built with -fPIC. On x86 and others, shared libraries may build without -fPIC. This can be wasteful and potentially cause a performance hit. +On some architectures, shared libraries must be built with -fPIC. On x86 and others, shared libraries may build without -fPIC. This can be wasteful and potentially cause a performance hit. -If you encounter a package that is not building shared libraries with -fPIC, patch the Makefile to build only the shared libraries with -fPIC. More information on PIC is available at the https://wiki.gentoo.org/wiki/Project:Hardened/Position_Independent_Code_internals;>PIC internals wiki page. If you are unsure, please ask in a public developer forum (like the gentoo-dev mailing list or #gentoo-dev irc channel) for help. +If you encounter a package that is not building shared libraries with -fPIC, patch the Makefile to build only the shared libraries with -fPIC. More information on PIC is available at the https://wiki.gentoo.org/wiki/Project:Hardened/Position_Independent_Code_internals;>PIC internals wiki page. If you are unsure, please ask in a public developer forum (like the gentoo-dev mailing list or #gentoo-dev IRC channel) for help.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/metadata/
commit: a93ddfdf28dd37d25e4967c8c97b5bc93be70d15
Author: Sam James gentoo org>
AuthorDate: Wed Jan 12 05:01:04 2022 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Jan 12 06:28:56 2022 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a93ddfdf
ebuild-writing/misc-files/metadata: minor phrasing tweak
Signed-off-by: Sam James gentoo.org>
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-writing/misc-files/metadata/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index a961821..2bc6100 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -633,8 +633,8 @@ specified in the subslots tag.
-Maintainer-needed, or orphaned, packages have no maintainers
-responsible for them. Per
+Maintainer-needed ("orphaned") packages have no maintainers responsible for
+them. Per
https://www.gentoo.org/glep/glep-0067.html#case-of-maintainer-needed-packages;>
GLEP 67, these packages must not contain any maintainer
subtags under pkgmetadata in their metadata.xml. A strict
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/common-mistakes/
commit: 7ce5e147a7ef3b776cb3910c0c21b999f7e2839b Author: Sam James gentoo org> AuthorDate: Sun Aug 1 02:50:13 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Dec 22 15:36:22 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7ce5e147 ebuild-writing/common-mistakes: add calling external tools without die Suggested-by: Joonas Niilola gentoo.org> Signed-off-by: Sam James gentoo.org> [Internal cross reference fixed] Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/common-mistakes/text.xml | 13 + 1 file changed, 13 insertions(+) diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml index e0cdd12..4e26462 100644 --- a/ebuild-writing/common-mistakes/text.xml +++ b/ebuild-writing/common-mistakes/text.xml @@ -13,6 +13,19 @@ writing ebuilds. Common Ebuild Writing Mistakes + +Unguarded external calls + + + +Calls to external tools should be guarded with || die (or use +assert) in almost all cases to allow failure to be detected. +See . + + + + + Invalid use of static use-flag
[gentoo-commits] proj/devmanual:master commit in: archs/amd64/
commit: 4e7a2e7b243be4ef2033097d1351e42c9be97fa1
Author: Ulrich Müller gentoo org>
AuthorDate: Fri Nov 12 19:22:58 2021 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Dec 22 14:51:30 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4e7a2e7b
archs/amd64: econf passes --libdir by default
Signed-off-by: Ulrich Müller gentoo.org>
archs/amd64/text.xml | 16 ++--
1 file changed, 2 insertions(+), 14 deletions(-)
diff --git a/archs/amd64/text.xml b/archs/amd64/text.xml
index cbfe8df..db9e9c5 100644
--- a/archs/amd64/text.xml
+++ b/archs/amd64/text.xml
@@ -232,22 +232,10 @@ this behaviour is controlled by the
MULTILIB_STRICT_EXEMPT variable in
-In most cases, it's sufficient to use the $(get_libdir) function:
+In most cases, default econf behaviour is sufficient, because it will
+pass the correct --libdir option to configure.
-
-src_compile() {
- econf \
- --libdir=/usr/$(get_libdir)
-
- emake || die
-}
-
-src_install() {
-emake DESTDIR="${D}" install || die
-}
-
-
Some packages provide really bad Makefiles which hard-code /usr/lib.
Those
should be sed -ed or patched. Don't forget to let upstream know about
your
[gentoo-commits] proj/devmanual:master commit in: archs/amd64/
commit: 0c7a9194274fd3248bee89b59268f1ad975b2db1
Author: Ulrich Müller gentoo org>
AuthorDate: Fri Nov 12 19:10:44 2021 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Dec 22 14:51:17 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=0c7a9194
archs/amd64: Update information on profiles
Signed-off-by: Ulrich Müller gentoo.org>
archs/amd64/text.xml | 158 +--
1 file changed, 40 insertions(+), 118 deletions(-)
diff --git a/archs/amd64/text.xml b/archs/amd64/text.xml
index b2acc1a..cbfe8df 100644
--- a/archs/amd64/text.xml
+++ b/archs/amd64/text.xml
@@ -143,141 +143,66 @@ variable and ).
-Libdir Links
+Libdir links
-Currently, we provide several profiles, each with its own combination of
libdir
-configurations.
+Currently, we provide several profiles, each with its own combination of
+libdir configurations. Table entries x86, amd64, etc. indicate that
+the directory contains objects for this ABI; entries with an arrow indicate
+a symlink to the respective directory.
-
- Profile
-
-
- lib32
-
-
- lib
-
-
- lib64
-
-
-
-
- 2004.3
-
-
- *l-emul*
-
-
- d64
-
-
- *l-lib*
-
+Profile
+lib
+lib32
+lib64
+libx32
-
- 2004.3/lib64
-
-
- *l-emul*
-
-
- *l-64*
-
-
- d64
-
+17.0
+- lib64
+x86
+amd64
+non-existent
-
- =2005.0
-
-
- d32
-
-
- *l-64*
-
-
- d64
-
+17.0/no-multilib
+- lib64
+non-existent
+amd64
+non-existent
-
- =2005.0/no-multilib
-
-
- d32
-
-
- *l-64*
-
-
- d64
-
+17.0/x32
+- libx32
+x86
+amd64
+x32
-
- =2005.0/no-symlink
-
-
- d32
-
-
- d
-
-
- d64
-
+17.1
+x86
+non-existent
+amd64
+non-existent
-
- =2005.0/no-symlink/no-lib32
-
-
- inexistant
-
-
- d32
-
-
- d64
-
+17.1/no-multilib
+n/a
+non-existent
+amd64
+non-existent
-
-
-d
-
-
-Directory containing mixed-bit objects
-
-
-dXX
-
-
-Directory containing XXbit objects
-
-
-l-foo
-
-
-Link to foo
-
-
-
-To always get the right path, you should use the function $(get_libdir)
-from . It will always
-return the correct directory, on all arches. And of course it also takes care
-of the ABI variable.
+To always get the right path, you should use $(get_libdir) which is
+available as a package manager function since EAPI 6. It will always return
+the correct directory, on all arches. And of course it also takes care of
+the ABI variable.
@@ -307,13 +232,10 @@ this behaviour is controlled by the
MULTILIB_STRICT_EXEMPT variable in
-In most cases, it's sufficient to use the $(get_libdir) function from
-:
+In most cases, it's sufficient to use the $(get_libdir) function:
-inherit multilib
-
src_compile() {
econf \
--libdir=/usr/$(get_libdir)
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 760deadbbcf094a896e85827eaf3089b2cc0f2cc
Author: Sam James gentoo org>
AuthorDate: Thu Dec 9 05:00:15 2021 +
Commit: Sam James gentoo org>
CommitDate: Thu Dec 9 05:00:15 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=760deadb
eclass-writing: drop unnecessary '|| die'
newins is already fatal on errors.
Signed-off-by: Sam James 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 40ec0be..2f316a3 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -605,7 +605,7 @@ domacosapp() {
[[ -z "${1}" ]] die "usage: domacosapp file [new
file]"
if use ppc-macos ; then
insinto /Applications
- newins "$1" "${2:-${1}}" || die "Failed to install ${1}"
+ newins "$1" "${2:-${1}}"
fi
}
[gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
commit: d9e28f40be32f76224ef0dbe2f3163e0615896f1
Author: Sam James gentoo org>
AuthorDate: Thu Dec 9 04:19:23 2021 +
Commit: Sam James gentoo org>
CommitDate: Thu Dec 9 04:24:29 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d9e28f40
general-concepts/autotools: use EAPI 8 in examples and autotools.eclass helpers
- Use EAPI 8 in examples
- Use eaclocal, eautoconf
- Define WANT_AUTOCONF/WANT_AUTOMAKE in global scope before inheriting
autotools.eclass. The eclass declares these as @PRE_INHERIT which
is necessary for e.g. ensuring dependencies are set.
Signed-off-by: Sam James gentoo.org>
general-concepts/autotools/text.xml | 45 ++---
1 file changed, 32 insertions(+), 13 deletions(-)
diff --git a/general-concepts/autotools/text.xml
b/general-concepts/autotools/text.xml
index b7170ba..11cacf3 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -116,23 +116,28 @@ either Makefile.am or configure.ac:
-EAPI=5
+EAPI=8
+WANT_AUTOCONF=2.5
+WANT_AUTOMAKE=1.9
inherit autotools
+IUSE="nls"
+
+BDEPEND="nls? ( sys-devel/gettext )"
+
src_prepare() {
+ default
+
# Remove problematic LDFLAGS declaration
sed -i -e '/^LDFLAGS/d' src/Makefile.am || die
# Rerun autotools
- einfo "Regenerating autotools files..."
- WANT_AUTOCONF=2.5 eautoconf
- WANT_AUTOMAKE=1.9 eautomake
+ eautoreconf
}
-src_compile() {
+src_configure() {
econf $(use_enable nls)
- emake
}
@@ -591,10 +596,17 @@ In the first case you usually want to do something like:
-einfo "Regenerating autotools files..."
-cp "${WORKDIR}/gentoo-m4" "${S}/m4" || die "m4 copy failed"
-WANT_AUTOCONF="2.5" aclocal -I "${S}/m4" || die "aclocal failed"
-WANT_AUTOCONF="2.5" autoconf || die "autoconf failed"
+WANT_AUTOCONF="2.5"
+inherit autotools
+
+src_prepare() {
+ default
+
+ einfo "Regenerating autotools files..."
+ cp "${WORKDIR}/gentoo-m4" "${S}/m4" || die "m4 copy failed"
+ eaclocal -I "${S}/m4"
+ eautoconf
+}
@@ -602,9 +614,16 @@ and so on. In the second case you can simplify it in this
way:
-einfo "Regenerating autotools files..."
-WANT_AUTOCONF="2.5" aclocal -I "${WORKDIR}/gentoo-m4" || die "aclocal failed"
-WANT_AUTOCONF="2.5" autoconf || die "autoconf failed"
+WANT_AUTOCONF="2.5"
+inherit autotools
+
+src_prepare() {
+ default
+
+ einfo "Regenerating autotools files..."
+ eaclocal -I "${WORKDIR}/gentoo-m4"
+ eautoconf
+}
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/functions/src_unpack/rpm-sources/
commit: 9899125938fb558df2dbb0d7c225fd90098f53d3
Author: Sam James gentoo org>
AuthorDate: Thu Dec 9 04:23:49 2021 +
Commit: Sam James gentoo org>
CommitDate: Thu Dec 9 04:24:31 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=98991259
ebuild-writing/functions/src_unpack/rpm-sources: use EAPI 8 in example
Signed-off-by: Sam James gentoo.org>
ebuild-writing/functions/src_unpack/rpm-sources/text.xml | 13 ++---
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
index ba78d4c..d29f592 100644
--- a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
+++ b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
@@ -28,7 +28,7 @@ src_unpack() {
rpm_src_unpack ${A}
cd "${S}"
- use ssl epatch "${FILESDIR}/${PV}/${P}-ssl.patch"
+ use ssl eapply "${FILESDIR}/${PV}/${P}-ssl.patch"
}
@@ -55,16 +55,17 @@ patches. The filename should be
suse-fetchmail-6.2.5.54.1.ebuild.
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI="6"
+EAPI=7
-inherit eapi7-ver rpm
+inherit rpm
MY_PV=$(ver_rs 3 '-')
MY_P=fetchmail-${MY_PV}
-SRC_URI="https://suse.osuosl.org/suse/i386/9.2/suse/src/${MY_P}.src.rpm;
DESCRIPTION="SuSE 9.2 Fetchmail Source Package"
HOMEPAGE="https://www.suse.com;
+SRC_URI="https://suse.osuosl.org/suse/i386/9.2/suse/src/${MY_P}.src.rpm;
+S=${WORKDIR}/fetchmail-$(ver_cut 1-3)
LICENSE="GPL-2 public-domain"
SLOT="0"
@@ -75,15 +76,13 @@ RESTRICT="mirror"
# Need to test if the file can be unpacked with rpmoffset and cpio
# If it can't then set:
-#DEPEND="app-arch/rpm"
+#BDEPEND="app-arch/rpm"
# To force the use of rpmoffset and cpio instead of rpm2cpio from
# app-arch/rpm, then set the following:
#USE_RPMOFFSET_ONLY=1
-S=${WORKDIR}/fetchmail-$(ver_cut 1-3)
-
src_unpack() {
rpm_src_unpack ${A}
}
[gentoo-commits] proj/devmanual:master commit in: general-concepts/virtuals/
commit: d19d95690f821f1a867f8e2095835056e988618f Author: Sam James gentoo org> AuthorDate: Thu Dec 9 04:21:47 2021 + Commit: Sam James gentoo org> CommitDate: Thu Dec 9 04:24:30 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d19d9569 general-concepts/virtuals: use EAPI 8 in examples Signed-off-by: Sam James gentoo.org> general-concepts/virtuals/text.xml | 12 +++- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/general-concepts/virtuals/text.xml b/general-concepts/virtuals/text.xml index d45c1ff..f6cf198 100644 --- a/general-concepts/virtuals/text.xml +++ b/general-concepts/virtuals/text.xml @@ -24,11 +24,11 @@ An example of a virtual: -EAPI=7 +EAPI=8 DESCRIPTION="Virtual for C++ tr1 type_traits" SLOT="0" -KEYWORDS="alpha amd64 arm hppa ia64 ~mips ppc ppc64 ~s390 sparc x86 ~x64-macos" +KEYWORDS="~alpha amd64 arm hppa ~ia64 ~mips ppc ppc64 ~s390 sparc x86 ~x64-macos" RDEPEND="|| ( =sys-devel/gcc-4.1 dev-libs/boost )" @@ -95,7 +95,7 @@ For example, a virtual for different packages providing ABI-compatible -EAPI=6 +EAPI=8 DESCRIPTION="Virtual for libfoo.so.1" SLOT="0/1" @@ -124,10 +124,11 @@ would contain: -EAPI=6 +EAPI=8 DESCRIPTION="Virtual for libfoo.so.0" SLOT="0/0" + RDEPEND="dev-libs/libfoo:0/0" @@ -136,10 +137,11 @@ while virtual/libfoo-1.ebuild would contain: -EAPI=6 +EAPI=8 DESCRIPTION="Virtual for libfoo.so.1" SLOT="0/1" + RDEPEND="dev-libs/newfoo:0/1"
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: 22633c2132444e7398db9d6de3fcfdd6e4cf4639
Author: Sam James gentoo org>
AuthorDate: Thu Dec 9 04:12:11 2021 +
Commit: Sam James gentoo org>
CommitDate: Thu Dec 9 04:12:11 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=22633c21
quickstart: mention PATCHES, use .patch and not .diff
- We expect contributions to use .patch and not .diff nowadays.
- Mention PATCHES so people are aware it's an option.
Signed-off-by: Sam James gentoo.org>
quickstart/text.xml | 16
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/quickstart/text.xml b/quickstart/text.xml
index fb9461e..caff4e5 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -257,8 +257,9 @@ for some more complex examples.
-Often we need to apply patches. This is done in the src_prepare
-function using the eapply helper function. To use eapply
+Often we need to apply patches. This is done either by defining the
+PATCHES array in global scope or in the src_prepare function
+using the eapply helper function. To use eapply,
one must use EAPI 7. Here's app-misc/detox/detox-1.1.0.ebuild:
@@ -266,7 +267,7 @@ one must use EAPI 7. Here's
app-misc/detox/detox-1.1.0.ebuild:
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI=7
+EAPI=8
DESCRIPTION="detox safely removes spaces and strange characters from filenames"
HOMEPAGE="http://detox.sourceforge.net/;
@@ -387,11 +388,10 @@ DEPEND="${RDEPEND}"
BDEPEND="dev-util/pkgconfig
nls? ( =sys-devel/gettext-0.12.1 )"
-src_prepare() {
- eapply "${FILESDIR}"/${PN}-namespace.diff \
- "${FILESDIR}"/${PN}-procmime.diff
- eapply_user
-}
+PATCHES=(
+ "${FILESDIR}"/${PN}-namespace.patch
+ "${FILESDIR}"/${PN}-procmime.patch
+)
src_configure() {
econf \
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: 55397dd4f01ba44c3931fe77e5b9fc0f3fef967b Author: Sam James gentoo org> AuthorDate: Thu Dec 9 04:09:03 2021 + Commit: Sam James gentoo org> CommitDate: Thu Dec 9 04:09:03 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=55397dd4 quickstart: add Oxford comma (minor grammar fix) Signed-off-by: Sam James gentoo.org> quickstart/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart/text.xml b/quickstart/text.xml index da2142b..fb9461e 100644 --- a/quickstart/text.xml +++ b/quickstart/text.xml @@ -241,7 +241,7 @@ and installing common documentation files works correctly for the package. -The BDEPEND, DEPEND and RDEPEND variables are how Portage +The BDEPEND, DEPEND, and RDEPEND variables are how Portage determines which packages are needed to build and run the package. The BDEPEND variable lists build-time (executable) dependencies, DEPEND variable lists compile-time dependencies, and the RDEPEND
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: 10513f99bcf89eacd4d7a55e5a939b526cbbc0fc Author: Sam James gentoo org> AuthorDate: Thu Dec 9 04:07:48 2021 + Commit: Sam James gentoo org> CommitDate: Thu Dec 9 04:08:12 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=10513f99 quickstart: mention BDEPEND Signed-off-by: Sam James gentoo.org> quickstart/text.xml | 10 ++ 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/quickstart/text.xml b/quickstart/text.xml index fd8e26b..da2142b 100644 --- a/quickstart/text.xml +++ b/quickstart/text.xml @@ -241,10 +241,12 @@ and installing common documentation files works correctly for the package. -The DEPEND and RDEPEND variables are how Portage determines which -packages are needed to build and run the package. The DEPEND variable lists -compile-time dependencies, and the RDEPEND lists runtime dependencies. See - for some more complex examples. +The BDEPEND, DEPEND and RDEPEND variables are how Portage +determines which packages are needed to build and run the package. The +BDEPEND variable lists build-time (executable) dependencies, +DEPEND variable lists compile-time dependencies, and the RDEPEND +lists runtime dependencies. See +for some more complex examples.
[gentoo-commits] proj/devmanual:master commit in: quickstart/
commit: de432135b7be55bb940683798eccaf6c89b341c8
Author: Sam James gentoo org>
AuthorDate: Thu Dec 9 04:06:00 2021 +
Commit: Sam James gentoo org>
CommitDate: Thu Dec 9 04:08:11 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=de432135
quickstart: use EAPI 8 in examples
Also adjust to ~alpha/~ia64 as both of these arches
are pure ~arch (no stable keywords) now.
Signed-off-by: Sam James gentoo.org>
quickstart/text.xml | 20 ++--
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/quickstart/text.xml b/quickstart/text.xml
index 09dbaad..fd8e26b 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -37,7 +37,7 @@ can see real ebuilds in the main tree).
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI=6
+EAPI=8
DESCRIPTION="Exuberant ctags generates tags files for quick source navigation"
HOMEPAGE="https://ctags.io/ https://github.com/universal-ctags/ctags;
@@ -206,7 +206,7 @@ Here's app-misc/detox/detox-1.1.1.ebuild:
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI=5
+EAPI=8
DESCRIPTION="detox safely removes spaces and strange characters from filenames"
HOMEPAGE="http://detox.sourceforge.net/;
@@ -219,7 +219,7 @@ KEYWORDS="~hppa ~mips sparc x86"
RDEPEND="dev-libs/popt"
DEPEND="${RDEPEND}
sys-devel/flex
- sys-devel/bison"
+BDEPEND="sys-devel/bison"
src_configure() {
econf --with-popt
@@ -276,8 +276,8 @@ KEYWORDS="~hppa ~mips ~sparc ~x86"
RDEPEND="dev-libs/popt"
DEPEND="${RDEPEND}
- sys-devel/flex
- sys-devel/bison"
+ sys-devel/flex"
+BDEPEND="sys-devel/bison"
src_prepare() {
eapply "${FILESDIR}"/${P}-destdir.patch \
@@ -320,7 +320,7 @@ replacement iconv for libc implementations which
don't have their own.
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI=5
+EAPI=8
DESCRIPTION="GNU charset conversion library for libc which doesn't implement
it"
HOMEPAGE="https://www.gnu.org/software/libiconv/;
@@ -359,7 +359,7 @@ Another more complicated example, this time based upon
# Copyright 1999-2021 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI=7
+EAPI=8
inherit desktop
@@ -369,7 +369,7 @@ SRC_URI="mirror://sourceforge/${PN}/${P}.tar.bz2"
LICENSE="GPL-2+ LGPL-2.1+"
SLOT="0"
-KEYWORDS="alpha amd64 hppa ia64 ppc ppc64 sparc x86"
+KEYWORDS="~alpha amd64 hppa ~ia64 ppc ppc64 sparc x86"
IUSE="crypt imlib ipv6 ldap nls pda ssl xface"
RDEPEND="=x11-libs/gtk+-2*
@@ -381,8 +381,8 @@ RDEPEND="=x11-libs/gtk+-2*
xface? ( =media-libs/compface-1.4 )
app-misc/mime-types
x11-misc/shared-mime-info"
-DEPEND="${RDEPEND}
- dev-util/pkgconfig
+DEPEND="${RDEPEND}"
+BDEPEND="dev-util/pkgconfig
nls? ( =sys-devel/gettext-0.12.1 )"
src_prepare() {
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/users-and-groups/
commit: fd83ad0b4b6be3ee7bb238cf04d63a9fa320 Author: Ulrich Müller gentoo org> AuthorDate: Tue Nov 16 15:53:31 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Nov 16 15:55:02 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd83 ebuild-writing/users-and-groups: Sync with QA policy UIDs and GIDs can be chosen from the range 101..749. Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/users-and-groups/text.xml | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ebuild-writing/users-and-groups/text.xml b/ebuild-writing/users-and-groups/text.xml index 9b2b49d..392a5b4 100644 --- a/ebuild-writing/users-and-groups/text.xml +++ b/ebuild-writing/users-and-groups/text.xml @@ -14,12 +14,12 @@ categories. First, check the https://api.gentoo.org/uid-gid.txt;>UID/GID -assignment list and choose a free UID/GID in the range between -101 and 499. If you are adding a user and a group with the same name, -use the same number for their UID and GID, respectively. When in doubt, -take the next free number from 499 downwards. The helper script -./bin/used_free_uidgids.sh available in the data/api.git repository can -be used to find the next available UID or GID. +assignment list and choose a free UID/GID in the range between 101 and +749. If you are adding a user and a group with the same name, use the same +number for their UID and GID, respectively. When in doubt, take the next free +number from 101 upwards. The helper script ./bin/used_free_uidgids.sh +available in the data/api.git repository can be used to find the next available +UID or GID.
[gentoo-commits] proj/devmanual:master commit in: archs/amd64/
commit: e3e013f2d5903ce8bfe5722631ffb517c9e3363a Author: Ulrich Müller gentoo org> AuthorDate: Fri Nov 12 11:10:24 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Nov 12 11:10:24 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e3e013f2 archs/amd64: Link to eclass documentation Signed-off-by: Ulrich Müller gentoo.org> archs/amd64/text.xml | 16 +--- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/archs/amd64/text.xml b/archs/amd64/text.xml index 06b4968..b2acc1a 100644 --- a/archs/amd64/text.xml +++ b/archs/amd64/text.xml @@ -69,8 +69,9 @@ doesn't help upstream at all. Another bad idea is to (ab)use append-flags function from -flag-o-matic.eclass. Applying -fPIC on all objects should not be -done. It should only be applied to shared objects. +. +Applying -fPIC on all objects should not be done. It should only be +applied to shared objects. @@ -135,7 +136,7 @@ To understand how this is done in the ebuild, read As you read above, 32bit applications must be linked against 32bit libraries. For that, we've made the most common libraries as multilib (via ABI -variable and multilib.eclass). +variable and ). @@ -273,9 +274,10 @@ configurations. -To always get the right path, you should use the function $(get_libdir) from -multilib.eclass. It will always return the correct directory, on all arches. -And of course it also takes care of the ABI variable. +To always get the right path, you should use the function $(get_libdir) +from . It will always +return the correct directory, on all arches. And of course it also takes care +of the ABI variable. @@ -306,7 +308,7 @@ this behaviour is controlled by the MULTILIB_STRICT_EXEMPT variable in In most cases, it's sufficient to use the $(get_libdir) function from -multilib.eclass: +:
[gentoo-commits] proj/devmanual:master commit in: archs/amd64/
commit: afaf341f4f3fdf6d866f16fa7c609223da6b8e5f Author: Azamat H. Hackimov gmail com> AuthorDate: Thu Nov 4 13:10:29 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Nov 12 11:09:28 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=afaf341f Updated information about 32bit compatibility emul-linux-x86-* packages removed long time ago. Closes: https://bugs.gentoo.org/821670 Signed-off-by: Azamat H. Hackimov gmail.com> Signed-off-by: Ulrich Müller gentoo.org> archs/amd64/text.xml | 19 +++ 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/archs/amd64/text.xml b/archs/amd64/text.xml index d615e8f..06b4968 100644 --- a/archs/amd64/text.xml +++ b/archs/amd64/text.xml @@ -129,28 +129,15 @@ To understand how this is done in the ebuild, read -The emul-linux-x86-* packages +32bit compatibility As you read above, 32bit applications must be linked against 32bit libraries. -For that, we've put together the most used libraries and stuck them into the -so-called emul-linux-x86 packages, which are located in the -app-emulation category. The current list of all the emul-linux-x86 -packages, can be found https://dev.gentoo.org/~pacho/emul.html;>here. +For that, we've made the most common libraries as multilib (via ABI +variable and multilib.eclass). - -These packages only provide pre-compiled libraries. Currently, the -archives are assembled manually, which is the main reason to keep the packages -as tidy as possible. Do not include libraries that aren't commonly used. - - - - The emul-packages might conflict with their native images, but only in - uncritical locations like /usr/share which are arch-independent anyway. - -
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: e20a78631323ed533041a23d0cb1f91e5f301713 Author: Mike Frysinger gentoo org> AuthorDate: Tue Oct 19 09:17:19 2021 + Commit: Mike Frysinger gentoo org> CommitDate: Tue Oct 19 09:27:14 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e20a7863 dependencies: clarify cross-compiling and system shorthands Try and clarify that BDEPEND/DEPEND are split based on the install targets, not only when the literal $CBUILD & $CHOST values differ, and thus only when "cross-compiling" is used. Signed-off-by: Mike Frysinger gentoo.org> general-concepts/dependencies/text.xml | 17 - 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index 1340b1c..a3ea540 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -34,15 +34,15 @@ for how dependencies and revisions interact. In order to avoid ambiguity, we use the following terms to indicate different -systems when cross-compiling: +systems when cross-compiling. They serve as a shorthand for an overall system +in addition to their literal value (e.g. $CHOST). CBUILD The system on which the build is performed. Dependencies that apply -to the CBUILD system can be executed during build time. When -cross-compiling, they are not installed into the system being built. +to the CBUILD system can be executed during build time. CHOST @@ -53,8 +53,15 @@ systems when cross-compiling: -When not cross-compiling, CBUILD and CHOST have the same value and both classes -of dependencies are merged. +When cross-compiling, CBUILD and CHOST are naturally different, as are the +actual install paths for the different types of dependencies. + + + +Note however that, while cross-compiling is used to help explain these concepts, +it is not strictly required. CBUILD and CHOST could target the exact same +hardware, but be installed into distinct SYSROOT/ROOT paths. The dependency +distinctions still apply even if it isn't, strictly speaking, cross-compiling.
[gentoo-commits] proj/devmanual:master commit in: .github/workflows/
commit: 331f4d4d585b9ac845da732aa3b8a5ae139418c4 Author: Ulrich Müller gentoo org> AuthorDate: Wed Oct 13 14:20:54 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Oct 13 14:20:54 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=331f4d4d .github/workflows/devmanual-ci.yml: Run apt-get update As recommended in documentation. Signed-off-by: Ulrich Müller gentoo.org> .github/workflows/devmanual-ci.yml | 10 ++ 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/devmanual-ci.yml b/.github/workflows/devmanual-ci.yml index 7f32e80..9d8e11f 100644 --- a/.github/workflows/devmanual-ci.yml +++ b/.github/workflows/devmanual-ci.yml @@ -15,15 +15,17 @@ jobs: build: runs-on: ubuntu-latest # no gentoo :( steps: -- uses: actions/checkout@v2 +- name: checkout + uses: actions/checkout@v2 - name: install prerequisites # librsvg2-bin for rsvg-convert # xsltproc for xsltproc # libxml2-utils for xmllint # tidy for tidy - run: > -sudo apt install -y librsvg2-bin xsltproc libxml2-utils tidy -fonts-open-sans + run: | +sudo apt-get -q -y update +sudo apt-get -q -y install librsvg2-bin xsltproc libxml2-utils \ +tidy fonts-open-sans - name: make run: make - name: make check
[gentoo-commits] proj/devmanual:master commit in: eclass-writing/
commit: 6e206d3e065884f4675b041e069a3b05663fa1f7 Author: Sam James gentoo org> AuthorDate: Tue Oct 5 04:37:49 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Oct 13 13:44:16 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6e206d3e eclass-writing: mention CCing maintainers on eclass patches Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 6 ++ 1 file changed, 6 insertions(+) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index db199f4..40ec0be 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -62,6 +62,12 @@ may be better off in its own eclass. If you don't email gentoo-dev first, and end up breaking something, expect to be in a lot of trouble. + +Note that you should also, when sending your patch, CC any maintainers of the +eclass listed in the @MAINTAINER tag. You may want to contact them +ahead of time and get their opinions too. + + The exceptions to this rule are updates to per-package eclasses. For example, the apache-2 eclass is only used by the www-servers/apache
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 6b5ff53adca1ad2fe5b3f9b2bb35245fd507ffab
Author: Joonas Niilola gentoo org>
AuthorDate: Sun Oct 10 10:09:26 2021 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Oct 13 13:40:35 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6b5ff53a
keywording: add ekeyword ~all command example
Signed-off-by: Joonas Niilola gentoo.org>
Signed-off-by: Ulrich Müller gentoo.org>
keywording/text.xml | 8 +---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/keywording/text.xml b/keywording/text.xml
index 74bca5d..cc10166 100644
--- a/keywording/text.xml
+++ b/keywording/text.xml
@@ -201,9 +201,11 @@ Do not commit straight to arch ("stable").
When upgrading, drop all existing keywords from arch to ~arch
-("testing"), and leave any existing ~arch keywords intact. This must be
-done even if you think you're just making a trivial fix there have
-been several examples of the stable tree getting broken this way.
+("testing"), and leave any existing ~arch keywords intact. It's easiest
+and safest to use ekeyword ~all my-new-version.ebuild from the
+app-portage/gentoolkit package. This must be done even if you think
+you're just making a trivial fix there have been several examples of the
+stable tree getting broken this way.
[gentoo-commits] proj/devmanual:master commit in: keywording/
commit: 42652857e3b5592b2001f13b041e66c341007ebe
Author: Joonas Niilola gentoo org>
AuthorDate: Sun Oct 10 10:03:33 2021 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Oct 13 13:40:35 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=42652857
keywording: wrap text at 80 chars
Signed-off-by: Joonas Niilola gentoo.org>
Signed-off-by: Ulrich Müller gentoo.org>
keywording/text.xml | 71 +++--
1 file changed, 36 insertions(+), 35 deletions(-)
diff --git a/keywording/text.xml b/keywording/text.xml
index 159d746..74bca5d 100644
--- a/keywording/text.xml
+++ b/keywording/text.xml
@@ -5,10 +5,10 @@
-Terminology: The term 'package' refers to an entire directory, for
example
-app-editors/vim it does not refer to a specific version.
The terms
-'ebuild' or 'package version' are used when this meaning is intended. This
-distinction is important.
+Terminology: The term 'package' refers to an entire directory, for
+example app-editors/vim it does not refer to a specific
+version. The terms 'ebuild' or 'package version' are used when this meaning is
+intended. This distinction is important.
@@ -41,8 +41,8 @@ The different levels of keyword are:
arch (x86, ppc-macos) ("stable")
-Both the package version and the ebuild are widely tested, known to
work
-and not have any serious issues on the indicated platform.
+Both the package version and the ebuild are widely tested, known to
+work and not have any serious issues on the indicated platform.
~arch (~x86, ~ppc-macos) ("testing")
@@ -72,9 +72,10 @@ The different levels of keyword are:
-The -* keyword is special. It is used to indicate package versions
which are
-not worth trying to test on unlisted arches. For example, a binary-only package
-which is only supported upstream on ppc and x86 might use:
+The -* keyword is special. It is used to indicate package versions which
+are not worth trying to test on unlisted arches. For example, a binary-only
+package which is only supported upstream on ppc and x86 might
+use:
@@ -103,23 +104,23 @@ do not specify a KEYWORDS variable.
-An ebuild must not depend upon any package that is of a lower keyword
level
-than itself. For example, if foo-1.2 depends upon bar-1.2, and
-bar-1.2 is ~x86, then foo-1.2 must not be marked
stable on
-x86 unless bar-1.2 is also stabilised.
+An ebuild must not depend upon any package that is of a lower keyword
+level than itself. For example, if foo-1.2 depends upon bar-1.2,
+and bar-1.2 is ~x86, then foo-1.2 must not be
marked
+stable on x86 unless bar-1.2 is also stabilised.
-You may assume that if a user accepts ~arch for a given arch then they
also
-accept arch.
+You may assume that if a user accepts ~arch for a given arch then they
+also accept arch.
-For optional dependencies, all possible dependencies must satisfy the
above.
-Note that certain USE flags can be forcibly disabled on a per-profile
basis
- talk to the arch teams if you require this. For either-or dependencies,
at
-least one of the options must be of equal or better visibility than the
-package in question.
+For optional dependencies, all possible dependencies must satisfy the
+above. Note that certain USE flags can be forcibly disabled on a
+per-profile basis talk to the arch teams if you require this. For
+either-or dependencies, at least one of the options must be of equal or
+better visibility than the package in question.
@@ -139,10 +140,10 @@ packages.
The only time it is acceptable for a user to see the Possibly a DEPEND
-problem error message is if they have manually changed visibility levels
for a
-package (for example, through /etc/portage/) and have missed a
dependency.
-You should never commit a change which could cause this error to appear on a
-user system.
+problem error message is if they have manually changed visibility levels
for
+a package (for example, through /etc/portage/) and have missed a
+dependency. You should never commit a change which could cause this error to
+appear on a user system.
@@ -162,12 +163,12 @@ a keywording bug instead for non-amd64/x86.
Do not assume that your package works on all architectures. Do
not
-assume that user submitted ebuilds will have correct KEYWORDS
chances are
-they just copied from somewhere else. Do not assume that upstream's
-'supported architectures' list is correct. Do not assume that because
your
-code is written in Perl / Python / Java / whatever that it will run on other
-arches (there is at least one case of a vim script which only worked on
-x86).
+assume that user submitted ebuilds will have correct KEYWORDS
+chances are they just copied from somewhere else. Do not assume that
+upstream's 'supported architectures' list is correct. Do not assume that
+because your code is written in Perl / Python / Java / whatever that it will
run
+on
[gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/
commit: c47bae818f63867150e6893232e289f242eb9622 Author: Sam James gentoo org> AuthorDate: Sun Oct 3 02:09:39 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Oct 13 13:39:14 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c47bae81 general-concepts/dependencies: clarify strong blocker usage Noticed we could be a bit clearer in the devmanual after a discussion on a PR [0]. We've had a lot of confusion over when it's appropriate to use strong blockers, so I think giving a non-abstract "example" is helpful here. [0] https://github.com/gentoo/gentoo/pull/22433#discussion_r720746670 Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> general-concepts/dependencies/text.xml | 6 ++ 1 file changed, 6 insertions(+) diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index c175cfa..1340b1c 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -305,6 +305,12 @@ the package from source, and may not apply once the package is installed or when it is installed from a binary package. + +The most common use for strong blockers is where another package simply +being installed causes a build failure. Strong blockers are not to be used +to prevent just file collisions. + + If both weak and strong blockers match a given package, the strong blocker takes precedence.
[gentoo-commits] proj/devmanual:master commit in: .github/workflows/
commit: 3a26abf23a2ce60b41016e9bbaf753128c35d1e1 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 11 11:12:06 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 11 11:12:06 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3a26abf2 .github/workflows/devmanual-ci.yml: Add license notice Presumably this is too short to be copyrightable. Adding the header anyway in case it may become longer. Signed-off-by: Ulrich Müller gentoo.org> .github/workflows/devmanual-ci.yml | 4 1 file changed, 4 insertions(+) diff --git a/.github/workflows/devmanual-ci.yml b/.github/workflows/devmanual-ci.yml index a304cd8..7f32e80 100644 --- a/.github/workflows/devmanual-ci.yml +++ b/.github/workflows/devmanual-ci.yml @@ -1,3 +1,7 @@ +# Copyright 2021 Gentoo Authors +# Distributed under the terms of the MIT license +# or the CC-BY-SA-4.0 license (dual-licensed) + name: Devmanual CI on:
[gentoo-commits] proj/devmanual:master commit in: .github/workflows/
commit: bd4d359a28ba506d8343993c8c6b9919a712a692 Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 11 10:54:48 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 11 10:54:48 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bd4d359a .github/workflows: Enable CI on Github Signed-off-by: Ulrich Müller gentoo.org> .github/workflows/devmanual-ci.yml | 26 ++ 1 file changed, 26 insertions(+) diff --git a/.github/workflows/devmanual-ci.yml b/.github/workflows/devmanual-ci.yml new file mode 100644 index 000..a304cd8 --- /dev/null +++ b/.github/workflows/devmanual-ci.yml @@ -0,0 +1,26 @@ +name: Devmanual CI + +on: + push: +branches: [master] + pull_request: +branches: [master] + workflow_dispatch: + +jobs: + build: +runs-on: ubuntu-latest # no gentoo :( +steps: +- uses: actions/checkout@v2 +- name: install prerequisites + # librsvg2-bin for rsvg-convert + # xsltproc for xsltproc + # libxml2-utils for xmllint + # tidy for tidy + run: > +sudo apt install -y librsvg2-bin xsltproc libxml2-utils tidy +fonts-open-sans +- name: make + run: make +- name: make check + run: make check
[gentoo-commits] proj/devmanual:master commit in: /
commit: 76f83d067b2ba64c7c1dca6659aa47bcefdca92d Author: Ulrich Müller gentoo org> AuthorDate: Mon Oct 11 10:53:09 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Oct 11 10:53:09 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=76f83d06 Makefile: Suppress warning about missing eclass-reference/text.xml Signed-off-by: Ulrich Müller gentoo.org> Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index cf57852..3409931 100644 --- a/Makefile +++ b/Makefile @@ -68,7 +68,7 @@ eclass-reference/text.xml: # the previous and next documents (for backward and forward links). # Generate the list of dependencies with XSLT, which appears to be a # better tool for this than make. -.depend: $(XMLS) depend.xsl devbook.xsl +.depend: $(XMLS) eclass-reference/text.xml depend.xsl devbook.xsl @xsltproc depend.xsl $(XMLS) | sed ':x;s%[^ /]*/\.\./%%;tx' > $@ install: all
[gentoo-commits] proj/devmanual:master commit in: /
commit: 80e024ed24de7784c4c891a721d40816f5eab4b2 Author: Ulrich Müller gentoo org> AuthorDate: Sun Oct 10 10:27:49 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Oct 10 10:33:56 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=80e024ed devbook.xsl: td doesn't have a nowrap attribute in HTML 5 Problem seen with tidy from app-text/htmltidy-5.8.0-r1. Signed-off-by: Ulrich Müller gentoo.org> Makefile| 2 +- devbook.xsl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 5d74d88..0a40cc3 100644 --- a/Makefile +++ b/Makefile @@ -86,7 +86,7 @@ validate: @xmllint --noout --dtdvalid devbook.dtd $(XMLS) \ && echo "xmllint validation successful" -# Run app-text/tidy-html5 on the output to detect mistakes. +# Run app-text/htmltidy on the output to detect mistakes. # We have to loop through them because otherwise tidy won't # tell you which file contains a mistake. tidy: $(HTMLS) $(ECLASS_HTMLS) diff --git a/devbook.xsl b/devbook.xsl index 5e8b260..1ebbb3b 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -84,7 +84,7 @@ - + white-space:
[gentoo-commits] proj/devmanual:master commit in: /
commit: 867c1219f744ac96c18ba44105008fce2dd60d70
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Oct 10 10:31:02 2021 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Oct 10 10:33:59 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=867c1219
Makefile: Add "check" target
Signed-off-by: Ulrich Müller gentoo.org>
Makefile | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 0a40cc3..cf57852 100644
--- a/Makefile
+++ b/Makefile
@@ -99,6 +99,8 @@ tidy: $(HTMLS) $(ECLASS_HTMLS)
test $${status} -eq 0 && echo "tidy validation successful"; \
exit $${status}
+check: validate tidy
+
dist:
COMMITDATE=$$(TZ=UTC git log -1 --pretty="format:%cd" \
--date="format-local:%Y%m%d"); \
@@ -109,6 +111,6 @@ dist:
clean:
@rm -f $(HTMLS) $(IMAGES) documents.js .depend
-.PHONY: all prereq build install validate tidy dist clean
+.PHONY: all prereq build install check validate tidy dist clean
-include .depend
[gentoo-commits] proj/devmanual:master commit in: general-concepts/mirrors/
commit: a7574212eac4741e41f07bf443273d08feff50c6
Author: Joonas Niilola gentoo org>
AuthorDate: Tue Sep 28 12:40:45 2021 +
Commit: Joonas Niilola gentoo org>
CommitDate: Sun Oct 10 10:18:29 2021 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a7574212
general-concepts/mirrors: update info about mirror://gentoo
- add a clearer note about chmod'ing your distfile,
- make it very clear that d.g.o:/space/distfiles-local is not
accessible anymore, and show the current way of hosting your own
distfiles,
- wrap the document source at 80 chars.
Signed-off-by: Joonas Niilola gentoo.org>
Closes: https://github.com/gentoo/devmanual/pull/253
general-concepts/mirrors/text.xml | 36 +---
1 file changed, 13 insertions(+), 23 deletions(-)
diff --git a/general-concepts/mirrors/text.xml
b/general-concepts/mirrors/text.xml
index 61b8618..c39c385 100644
--- a/general-concepts/mirrors/text.xml
+++ b/general-concepts/mirrors/text.xml
@@ -42,8 +42,8 @@ This should not be used in new ebuilds.
There is also RESTRICT="fetch", which prevents Portage from trying to
fetch anything manually. The
-pkg_nofetch function will be called if any SRC_URI components
cannot be
-found. This should only be used if a license requires it.
+pkg_nofetch function will be called if any SRC_URI components
+cannot be found. This should only be used if a license requires it.
@@ -100,15 +100,16 @@ devspace.
-Previous policy was to use mirror://gentoo directly, but this is now
deprecated, as that
-wouldn't allow to have long-term availability and traceability of the source
files, which might be a
-requirement of the license.
+Previous policy was to use mirror://gentoo directly, but this is now
+prohibited, as that wouldn't allow to have long-term availability and
+traceability of the source files, which might be a requirement of the license.
-When you upload the file to dev.gentoo.org:~/public_html, you must
ensure that it, and its
-parent directories, are world-readable. An example SRC_URI referencing
-a distfile mirrored this way is as follows:
+When you upload the distfile to dev.gentoo.org:~/public_html, ensure
that
+your file and its parent directories have the correct permissions, so they're
+accessible. An example SRC_URI referencing a distfile mirrored this way
+is as follows:
@@ -119,25 +120,14 @@
SRC_URI="https://dev.gentoo.org/~myname/distfiles/${P}.tar.gz;
where myname refers to the username of the developer.
-
-
-
-
-
-Gentoo Mirrors
-
-
-To manually upload a file to mirror://gentoo, scp it to
-dev.gentoo.org:/space/distfiles-local. The file should appear
-on the mirrors within four hours (note that this is less
-frequent than ).
-
If the upstream download location for a package uses a non-standard TCP port
-(anything other than 21, 80 or 443), you must manually mirror the
files. Not
-doing so can cause all kinds of problems with strict firewalls.
+(anything other than 21, 80 or 443), you must manually mirror the files.
+Not doing so can cause all kinds of problems with strict firewalls.
+
+
[gentoo-commits] proj/devmanual:master commit in: general-concepts/copyright-policy/
commit: 95a410bde2def81a15840bb7aa016bc25a0f793c Author: Ulrich Müller gentoo org> AuthorDate: Mon Sep 27 16:52:07 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Mon Sep 27 16:52:07 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=95a410bd general-concepts/copyright-policy: Small touchups Signed-off-by: Ulrich Müller gentoo.org> general-concepts/copyright-policy/text.xml | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/general-concepts/copyright-policy/text.xml b/general-concepts/copyright-policy/text.xml index c8a488b..a4ad96e 100644 --- a/general-concepts/copyright-policy/text.xml +++ b/general-concepts/copyright-policy/text.xml @@ -1,7 +1,7 @@ -Gentoo's copyright policy +Copyright Policy @@ -25,8 +25,8 @@ Foundation per-case basis. -Per Gentoo's https://www.gentoo.org/glep/glep-0076.html;>GLEP 76 -(Copyright Policy GLEP), you must sign-off all your commits to any +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 https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin;> copyright policy. @@ -53,7 +53,7 @@ author is, or is not required. The list below serves as a general guideline. software license. The committer adds another S-o-b line and certifies the commit under point 4 of the https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin;> -GCO. +Certificate of Origin. Use common sense here, especially if you don't know the contributor. If the contribution was taken from somewhere else and the contributor doesn't have @@ -70,7 +70,7 @@ author is, or is not required. The list below serves as a general guideline. Can be accepted. The committer adds a S-o-b line and certifies the commit -under GCO point 2. +under point 2 of the Certificate of Origin. A contribution without a S-o-b line but not @@ -79,7 +79,7 @@ author is, or is not required. The list below serves as a general guideline. Can be accepted. The committer adds a S-o-b line and certifies the commit -under GCO point 2. +under point 2 of the Certificate of Origin. A contribution without a S-o-b line and of significant size, without any
[gentoo-commits] proj/devmanual:master commit in: general-concepts/copyright-policy/, general-concepts/
commit: 4c395f6b1071fee86f0d296df0750958e4a5acca Author: Joonas Niilola gentoo org> AuthorDate: Tue Sep 21 12:51:46 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Sep 26 09:03:18 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4c395f6b general-concepts/copyright-policy/: new page Signed-off-by: Joonas Niilola gentoo.org> [Delete trailing whitespace.] Signed-off-by: Ulrich Müller gentoo.org> general-concepts/copyright-policy/text.xml | 99 ++ general-concepts/text.xml | 1 + 2 files changed, 100 insertions(+) diff --git a/general-concepts/copyright-policy/text.xml b/general-concepts/copyright-policy/text.xml new file mode 100644 index 000..c8a488b --- /dev/null +++ b/general-concepts/copyright-policy/text.xml @@ -0,0 +1,99 @@ + + + +Gentoo's copyright policy + + + +https://www.gentoo.org/glep/glep-0076.html;>GLEP-76 defines +copyright and license policies for Gentoo Linux. + + + +Every Gentoo project must abide by the +https://www.gentoo.org/get-started/philosophy/social-contract.html;> +Gentoo Social Contract and release its work under one or more of +https://www.gentoo.org/glep/glep-0076.html#licensing-of-gentoo-projects;> +predetermined licenses. Exceptions may be granted by the Gentoo +Foundation per-case basis. + + + + + +Certificate of Origin + + + +Per Gentoo's https://www.gentoo.org/glep/glep-0076.html;>GLEP 76 +(Copyright Policy GLEP), 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. + + + +When committing work authored by someone else, e.g. a Bugzilla patch, or GitHub +pull request, a sign-off from the original author is always strongly +recommended, in order to indicate that the author acknowledges Gentoo's +copyright policy. However, it is not mandatory for every case. Please refer to +the example list below when determining whether a sign-off from the original +author is, or is not required. The list below serves as a general guideline. + + + + +Examples for 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 +https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin;> +GCO. + +Use common sense here, especially if you don't know the contributor. If the +contribution was taken from somewhere else and the contributor doesn't have +the right to distribute it under a free software license, you as the +committer might get into trouble. So in this situation, do your best to +check repositories for matching code, and whether they hold any special +copyright claims. + + + +A contribution without a S-o-b line and of significant size, but with an +independent indication of its license (e.g. copyright and license notices +in the file's header) + + +Can be accepted. The committer adds a S-o-b line and certifies the commit +under GCO point 2. + + +A contribution without a S-o-b line but not +https://www.gnu.org/prep/maintain/html_node/Legally-Significant.html;> +"legally significant" (by the FSF's 15-lines rule of thumb) + + +Can be accepted. The committer adds a S-o-b line and certifies the commit +under GCO point 2. + + +A contribution without a S-o-b line and of significant size, without any +other indication of its license + + +Can not be accepted. There's no indication that the author has +released their work under a free license, therefore it must not be +distributed by Gentoo. + + + + + + + + diff --git a/general-concepts/text.xml b/general-concepts/text.xml index ace731e..dd7a7c2 100644 --- a/general-concepts/text.xml +++ b/general-concepts/text.xml @@ -22,6 +22,7 @@ writing ebuilds or working with the Gentoo repository. +
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
commit: b541292297e709a13bcd90ce6ba5c61d9ba5eed7 Author: Joonas Niilola gentoo org> AuthorDate: Tue Sep 21 12:55:24 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Sep 26 09:03:52 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b5412922 ebuild-maintenance/git: link to general-concepts/copyright-policy Signed-off-by: Joonas Niilola gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-maintenance/git/text.xml | 7 +++ 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml index 0cad9bf..cf8d6ba 100644 --- a/ebuild-maintenance/git/text.xml +++ b/ebuild-maintenance/git/text.xml @@ -145,10 +145,9 @@ manually verify all packages affected by the commit using repoman full or pkgcheck scan --commits. When using repoman, it won't be aware of staged changes, so ensure that all files are included in the commit. Also, when using git manually, you must perform a manual sign-off to the -https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin;> -Certificate of Origin using the -s or --signoff option -with your git commit commands. Make sure you have read and understand the -actual Certificate. + using +the -s or --signoff option with your git commit commands. Make +sure you have read and understand the actual certificate.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: 961b201b450c52b5835a995a7c6812497d36 Author: Ulrich Müller gentoo org> AuthorDate: Fri Sep 24 14:05:23 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Sep 24 14:05:23 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=961b2033 general-concepts/ebuild-revisions: Fix link syntax Fixes: 22a7fb2ca3bc0897a80b27470da1f9b5f06dd874 Signed-off-by: Ulrich Müller gentoo.org> general-concepts/ebuild-revisions/text.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index 55e1387..755e0cf 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -111,8 +111,8 @@ of thumb could be used as a guideline: a dependency change due to - -removal of a virtual package. + +removal of a virtual package.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: 22a7fb2ca3bc0897a80b27470da1f9b5f06dd874 Author: Joonas Niilola gentoo org> AuthorDate: Mon Sep 6 12:48:05 2021 + Commit: Joonas Niilola gentoo org> CommitDate: Fri Sep 24 11:59:38 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=22a7fb2c general-concepts/ebuild-revisions: mention removing a virtual pkg Signed-off-by: Joonas Niilola gentoo.org> general-concepts/ebuild-revisions/text.xml | 7 ++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index 00e60c5..89ed8ea 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -105,7 +105,12 @@ of thumb could be used as a guideline: is equivalent to the old code), -a dependency change that is a result of a package move (slot move). +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/ebuild-revisions/
commit: cca1990a25e204e5c8dd6cbbad0f0436a26c3115 Author: Joonas Niilola gentoo org> AuthorDate: Mon Sep 6 12:56:23 2021 + Commit: Joonas Niilola gentoo org> CommitDate: Fri Sep 24 11:59:38 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=cca1990a general-concepts/ebuild-revisions: clarify the automagic dep detection - the current example is very hard to realize what it means, I'm only guessing it means automagic dep detection? Let's update it to make it clearer? Signed-off-by: Joonas Niilola gentoo.org> general-concepts/ebuild-revisions/text.xml | 5 + 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index 89ed8ea..1bcd23f 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -69,10 +69,7 @@ of thumb could be used as a guideline: adding a missing runtime dependency to one of the existing blocks, adding a binding subslot operator (:=) to a dependency, updating a dependency with default on/off USE flags, - -adding a missing build-time dependency that contributed to -a successfully yet incorrect build (e.g. missing some feature), - + fixing an automagic dependency detection from a build system, restricting a runtime dependency version, unless the := subslot operator is going to trigger a rebuild.
[gentoo-commits] proj/devmanual:master commit in: general-concepts/ebuild-revisions/
commit: dcde372b99383c87ffe2fed23061f9f42b61b101 Author: Joonas Niilola gentoo org> AuthorDate: Tue Sep 7 08:12:55 2021 + Commit: Joonas Niilola gentoo org> CommitDate: Fri Sep 24 11:59:38 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dcde372b general-concepts/ebuild-revisions: mention EAPI bump Signed-off-by: Joonas Niilola 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 1bcd23f..f5e8be8 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -72,7 +72,11 @@ of thumb could be used as a guideline: fixing an automagic dependency detection from a build system, restricting a runtime dependency version, unless the := -subslot operator is going to trigger a rebuild. +subslot operator is going to trigger a rebuild, + + +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: general-concepts/ebuild-revisions/
commit: 384ff6b951ddc1ecb29c241b54e96bc4c90bef39 Author: Joonas Niilola gentoo org> AuthorDate: Tue Sep 7 08:15:01 2021 + Commit: Joonas Niilola gentoo org> CommitDate: Fri Sep 24 11:59:38 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=384ff6b9 general-concepts/ebuild-revisions: mention pkgdev as alternative Signed-off-by: Joonas Niilola gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/248 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 f5e8be8..55e1387 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -52,8 +52,9 @@ of thumb could be used as a guideline: etc.) and it would not be propagated using other means, then the ebuild should be renamed to a new revision. If the package has stable keywords, they should be moved to the new revision without -dropping. To commit the ebuild, repoman commit ---straight-to-stable option should be used. +dropping. To commit the ebuild, repoman commit --straight-to-stable +option should be used. (Alternatively, pkgdev commit or git +commit paired with pkgcheck scan --commits).
