diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2023-10-27 12:22:01 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2023-10-30 17:21:14 +0100 |
| commit | 2556659c7a76dd00176efd7892e02ca0130998e2 (patch) | |
| tree | 6bbbde24e64ac2395033b8a1c1cda8a3e3f7aa58 /ebuild-writing | |
| parent | devbook.xsl: Warn about missing terminating slash in internal links (diff) | |
| download | devmanual-2556659c7a76dd00176efd7892e02ca0130998e2.tar.gz devmanual-2556659c7a76dd00176efd7892e02ca0130998e2.tar.bz2 devmanual-2556659c7a76dd00176efd7892e02ca0130998e2.zip | |
Fix internal links
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'ebuild-writing')
| -rw-r--r-- | ebuild-writing/common-mistakes/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/error-handling/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/file-format/text.xml | 13 | ||||
| -rw-r--r-- | ebuild-writing/functions/pkg_nofetch/text.xml | 4 | ||||
| -rw-r--r-- | ebuild-writing/functions/pkg_preinst/text.xml | 6 | ||||
| -rw-r--r-- | ebuild-writing/functions/src_compile/build-environment/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/functions/src_install/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/functions/src_prepare/epatch/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/functions/text.xml | 13 | ||||
| -rw-r--r-- | ebuild-writing/misc-files/metadata/text.xml | 5 | ||||
| -rw-r--r-- | ebuild-writing/user-submitted/text.xml | 2 | ||||
| -rw-r--r-- | ebuild-writing/using-eclasses/text.xml | 8 | ||||
| -rw-r--r-- | ebuild-writing/variables/text.xml | 34 |
13 files changed, 48 insertions, 47 deletions
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml index a61c701..41f6d35 100644 --- a/ebuild-writing/common-mistakes/text.xml +++ b/ebuild-writing/common-mistakes/text.xml @@ -52,7 +52,7 @@ information. </p> <p> -See also <uri link="::ebuild-writing/variables#ROOT"/>. +See also <uri link="::ebuild-writing/variables/#ROOT"/>. </p> </body> </subsection> diff --git a/ebuild-writing/error-handling/text.xml b/ebuild-writing/error-handling/text.xml index 02fd3af..f8171f5 100644 --- a/ebuild-writing/error-handling/text.xml +++ b/ebuild-writing/error-handling/text.xml @@ -54,7 +54,7 @@ the <uri link="::eclass-reference/">eclass reference</uri> when in doubt. <p> Sometimes displaying additional error information beforehand can be useful. Use -<c>eerror</c> to do this. See <uri link="::ebuild-writing/messages"/>. +<c>eerror</c> to do this. See <uri link="::ebuild-writing/messages/"/>. </p> <note> diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml index 63b7f5e..ff7fb91 100644 --- a/ebuild-writing/file-format/text.xml +++ b/ebuild-writing/file-format/text.xml @@ -102,12 +102,13 @@ No integer part of the version may be longer than 18 digits. </p> <p> -Finally, version may have a Gentoo revision number in the form <c>-r1</c>. The initial -Gentoo version should have no revision suffix, the first revision should be -<c>-r1</c>, the second <c>-r2</c> and so on. See <uri link="::general-concepts/ebuild-revisions"/>. -Revision numbers are distinguished from patch releases by revision bumps being -changes by Gentoo developers, while patch releases are new releases by upstream (with the exception -of snapshots, see below). +Finally, version may have a Gentoo revision number in the form <c>-r1</c>. +The initial Gentoo version should have no revision suffix, the first revision +should be <c>-r1</c>, the second <c>-r2</c> and so on. +See <uri link="::general-concepts/ebuild-revisions/"/>. Revision numbers are +distinguished from patch releases by revision bumps being changes by Gentoo +developers, while patch releases are new releases by upstream (with the +exception of snapshots, see below). </p> <p> diff --git a/ebuild-writing/functions/pkg_nofetch/text.xml b/ebuild-writing/functions/pkg_nofetch/text.xml index 5d7f87c..fdf4639 100644 --- a/ebuild-writing/functions/pkg_nofetch/text.xml +++ b/ebuild-writing/functions/pkg_nofetch/text.xml @@ -67,8 +67,8 @@ be referenced. <title>Notes on <c>pkg_nofetch</c></title> <body> <p> -This function is only triggered for packages which -have <c>RESTRICT="fetch"</c> (see <uri link="::general-concepts/mirrors#Restricting Automatic Mirroring"/>) +This function is only triggered for packages which have <c>RESTRICT="fetch"</c> +(see <uri link="::general-concepts/mirrors/#Restricting Automatic Mirroring"/>) set, and only if one or more components listed in <c>SRC_URI</c> are not already available in the <c>distfiles</c> directory. </p> diff --git a/ebuild-writing/functions/pkg_preinst/text.xml b/ebuild-writing/functions/pkg_preinst/text.xml index 5c47280..ee78f6c 100644 --- a/ebuild-writing/functions/pkg_preinst/text.xml +++ b/ebuild-writing/functions/pkg_preinst/text.xml @@ -62,7 +62,7 @@ There are a few things that are often done in <c>pkg_preinst</c>: <li> Adding users and groups. However, since <c>pkg_preinst</c> may be called after <c>src_compile</c>, <c>pkg_setup</c> is the more suitable location for - user creation <d/> see <uri link="::ebuild-writing/users-and-groups"/>. + user creation <d/> see <uri link="::ebuild-writing/users-and-groups/"/>. </li> <li> Modifying the install image for a particular system. This function @@ -71,9 +71,9 @@ There are a few things that are often done in <c>pkg_preinst</c>: configuration file updating <d/> a <c>pkg_preinst</c> could check a configuration file in <c>${ROOT}/etc/</c> and create a smart updated version in <c>${D}/etc/</c> (see - <uri link="::general-concepts/install-destinations"/>) rather than + <uri link="::general-concepts/install-destinations/"/>) rather than always trying to install the default configuration file (remember - <uri link="::general-concepts/config-protect"/>). + <uri link="::general-concepts/config-protect/"/>). </li> </ul> </body> diff --git a/ebuild-writing/functions/src_compile/build-environment/text.xml b/ebuild-writing/functions/src_compile/build-environment/text.xml index 18d88b7..1aa826e 100644 --- a/ebuild-writing/functions/src_compile/build-environment/text.xml +++ b/ebuild-writing/functions/src_compile/build-environment/text.xml @@ -18,7 +18,7 @@ Except where otherwise specified, any function which operates on <p> Ebuilds must not simply ignore user CFLAGS, CXXFLAGS or LDFLAGS <d/> see -<uri link="::general-concepts/user-environment#Not Filtering Variables"/>. +<uri link="::general-concepts/user-environment/#Not Filtering Variables"/>. </p> </body> diff --git a/ebuild-writing/functions/src_install/text.xml b/ebuild-writing/functions/src_install/text.xml index 917a999..66a8e3d 100644 --- a/ebuild-writing/functions/src_install/text.xml +++ b/ebuild-writing/functions/src_install/text.xml @@ -147,7 +147,7 @@ compilation required) themes: <p> Or sometimes a combination of <c>insinto</c> and <c>doins</c> (plus related -functions <d/> see <uri link="::function-reference/install-functions"/>) <d/> +functions <d/> see <uri link="::function-reference/install-functions/"/>) <d/> the following is based upon the <c>sys-fs/udev</c> install: </p> diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml b/ebuild-writing/functions/src_prepare/epatch/text.xml index aa63f2d..ba77549 100644 --- a/ebuild-writing/functions/src_prepare/epatch/text.xml +++ b/ebuild-writing/functions/src_prepare/epatch/text.xml @@ -94,7 +94,7 @@ src_prepare() { For larger patches, using <uri link="::general-concepts/mirrors/#Suitable Download Hosts"> your devspace</uri> rather than -<uri link="::ebuild-writing/variables#Predefined Read-Only Variables"> +<uri link="::ebuild-writing/variables/#Predefined Read-Only Variables"> ${FILESDIR}</uri> is more appropriate. In these situations, it is usually best to compress the patch in question with <c>xz</c> or <c>bzip2</c> (as opposed to <c>${FILESDIR}</c> patches, which must not diff --git a/ebuild-writing/functions/text.xml b/ebuild-writing/functions/text.xml index 0a98f4a..47babef 100644 --- a/ebuild-writing/functions/text.xml +++ b/ebuild-writing/functions/text.xml @@ -9,11 +9,12 @@ When installing packages from source, the phase function call order is <c>pkg_pretend</c>, <c>pkg_setup</c>, <c>src_unpack</c>, <c>src_prepare</c>, <c>src_configure</c>, <c>src_compile</c>, <c>src_test</c> (optional, <c>FEATURES="test"</c>), -<c>src_install</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>. When installing packages -from a binary, the phase function call order is <c>pkg_pretend</c>, +<c>src_install</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>. When installing +packages from a binary, the phase function call order is <c>pkg_pretend</c>, <c>pkg_setup</c>, <c>pkg_preinst</c>, <c>pkg_postinst</c>. -As some phases haven't been introduced from the beginning, you can have a look at -<uri link="::ebuild-writing/eapi"/> for an overview, what have been introduced in which EAPI. +As some phases haven't been introduced from the beginning, you can have a look +at <uri link="::ebuild-writing/eapi/"/> for an overview, what have been +introduced in which EAPI. </p> <p> @@ -59,12 +60,12 @@ Downloading a package's source happens before any of these phases, so <c>emerge --fetchonly</c> should perform all the network access you need (unless you're using live ebuilds). Network access outside of this would not be cached locally (e.g. in <c>${DISTDIR}</c>, see -<uri link="::ebuild-writing/variables#Predefined Read-Only Variables"/>), +<uri link="::ebuild-writing/variables/#Predefined Read-Only Variables"/>), which makes it hard to have reproducible builds (see <uri link="::ebuild-writing/functions/src_unpack/vcs-sources/#Disadvantages of VCS Sources"/>). Avoid network access in any phase by using local files, extending <c>SRC_URI</c> (see -<uri link="::ebuild-writing/variables#Ebuild-defined Variables"/>), etc. +<uri link="::ebuild-writing/variables/#Ebuild-defined Variables"/>), etc. </p> </body> diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml index b443b4c..fb0dab1 100644 --- a/ebuild-writing/misc-files/metadata/text.xml +++ b/ebuild-writing/misc-files/metadata/text.xml @@ -131,7 +131,7 @@ metadata.xml: <ti><c><slots></c></ti> <ti> This tag describes the - <uri link="::general-concepts/slotting">slots</uri> of a package. + <uri link="::general-concepts/slotting/">slots</uri> of a package. It has two optional subtags: <c><slot></c> and <c><subslots></c>. </ti> @@ -342,8 +342,7 @@ There are also some attributes that can be used with these tags: Defines the type of the maintainer for a package. There are only two valid values: <c>"person"</c> and <c>"project"</c>. The latter denotes an official - <uri link="::general-concepts/projects"> - Gentoo project</uri>. + <uri link="::general-concepts/projects/">Gentoo project</uri>. </ti> </tr> diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index 9b117d6..58a372d 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -24,7 +24,7 @@ The user-submitted ebuild must not contain custom headers like this: Such information should be included in the git commit message instead. The use of tags such as <c>Suggested-By:</c> or <c>Reported-By:</c> in the commit message, as explained in the -<uri link="::ebuild-maintenance/git#Git Commit Message Format"> +<uri link="::ebuild-maintenance/git/#Git Commit Message Format"> commit message format section</uri>, is highly encouraged. Note that ebuilds received in the form of git patches or pull requests will have the user as the commit author by default, in which case diff --git a/ebuild-writing/using-eclasses/text.xml b/ebuild-writing/using-eclasses/text.xml index 29b1b9a..db41d25 100644 --- a/ebuild-writing/using-eclasses/text.xml +++ b/ebuild-writing/using-eclasses/text.xml @@ -19,10 +19,10 @@ how to use an eclass which has already been written. <p> To use an eclass, it must be 'inherited'. This is done via the <c>inherit</c> -function, which is provided by <c>ebuild.sh</c>. The <c>inherit</c> statement must -come at the top of the ebuild, <e>before</e> any functions. Conditional inherits are -illegal (except where the inheritance criteria are cache-constant <d/> see <uri -link="::general-concepts/portage-cache"/>). +function, which is provided by <c>ebuild.sh</c>. The <c>inherit</c> statement +must come at the top of the ebuild, <e>before</e> any functions. +Conditional inherits are illegal (except where the inheritance criteria are +cache-constant <d/> see <uri link="::general-concepts/portage-cache/"/>). </p> <p> diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 8f40b52..af03749 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -102,8 +102,8 @@ for these variables when writing ebuilds. <ti><c>ROOT</c></ti> <ti> The absolute path to the root directory into which the package is to be - merged. Only allowed in pkg_* phases. See - <uri link="::ebuild-writing/variables#ROOT"/> + merged. Only allowed in pkg_* phases. + See <uri link="::ebuild-writing/variables/#ROOT"/> </ti> </tr> <tr> @@ -254,7 +254,7 @@ The following variables may or must be defined by every ebuild. <tr> <ti><c>EAPI</c></ti> <ti> - The EAPI. See <uri link="::ebuild-writing/eapi"/>. + The EAPI. See <uri link="::ebuild-writing/eapi/"/>. </ti> </tr> <tr> @@ -282,7 +282,7 @@ The following variables may or must be defined by every ebuild. <ti> A list of source URIs for the package. Can contain <c>USE</c>-conditional parts, see - <uri link="::ebuild-writing/variables#SRC_URI"/>. + <uri link="::ebuild-writing/variables/#SRC_URI"/>. </ti> </tr> <tr> @@ -290,20 +290,20 @@ The following variables may or must be defined by every ebuild. <ti> The package's license, corresponding exactly (including case) to a file in <c>licenses/</c>. Mandatory (except for virtuals). - See <uri link="::ebuild-writing/variables#LICENSE"/>. + See <uri link="::ebuild-writing/variables/#LICENSE"/>. </ti> </tr> <tr> <ti><c>SLOT</c></ti> <ti> The package's <c>SLOT</c>. Mandatory. - See <uri link="::ebuild-writing/variables#SLOT"/>. + See <uri link="::ebuild-writing/variables/#SLOT"/>. </ti> </tr> <tr> <ti><c>KEYWORDS</c></ti> <ti> - See <uri link="::ebuild-writing/variables#KEYWORDS"/> and + See <uri link="::ebuild-writing/variables/#KEYWORDS"/> and <uri link="::keywording/"/>. </ti> </tr> @@ -311,8 +311,8 @@ The following variables may or must be defined by every ebuild. <ti><c>IUSE</c></ti> <ti> A list of all <c>USE</c> flags (excluding arch flags, but - including <c>USE_EXPAND</c> flags) used within the ebuild. See - <uri link="::ebuild-writing/variables#IUSE"/>. + including <c>USE_EXPAND</c> flags) used within the ebuild. + See <uri link="::ebuild-writing/variables/#IUSE"/>. </ti> </tr> <tr> @@ -341,23 +341,23 @@ The following variables may or must be defined by every ebuild. <tr> <ti><c>DEPEND</c></ti> <ti> - A list of the package's build dependencies. See - <uri link="::general-concepts/dependencies"/>. + A list of the package's build dependencies. + See <uri link="::general-concepts/dependencies/"/>. Starting with EAPI-7, applies to CHOST only. </ti> </tr> <tr> <ti><c>BDEPEND</c></ti> <ti> - (EAPI=7) A list of the package's CBUILD build dependencies. See - <uri link="::general-concepts/dependencies"/>. + (EAPI=7) A list of the package's CBUILD build dependencies. + See <uri link="::general-concepts/dependencies/"/>. </ti> </tr> <tr> <ti><c>RDEPEND</c></ti> <ti> - A list of the package's runtime dependencies. See - <uri link="::general-concepts/dependencies"/>. + A list of the package's runtime dependencies. + See <uri link="::general-concepts/dependencies/"/>. </ti> </tr> <tr> @@ -365,7 +365,7 @@ The following variables may or must be defined by every ebuild. <ti> A list of packages to be installed (if possible) after the package is merged. Use this <e>only</e> when <c>RDEPEND</c> would cause cyclic - dependencies. See <uri link="::general-concepts/dependencies"/>. + dependencies. See <uri link="::general-concepts/dependencies/"/>. </ti> </tr> <tr> @@ -498,7 +498,7 @@ There are two valid cases for using <c>thirdpartymirrors</c>: <p> In any other case, the primary location must be used instead. The distfiles -will be <uri link="::general-concepts/mirrors">mirrored onto Gentoo +will be <uri link="::general-concepts/mirrors/">mirrored onto Gentoo infrastructure</uri>; in that case, the benefit to using third-party mirror list does not outweigh the burden of maintaining it. </p> |