diff options
author | 2023-10-27 12:22:01 +0200 | |
---|---|---|
committer | 2023-10-30 17:21:14 +0100 | |
commit | 2556659c7a76dd00176efd7892e02ca0130998e2 (patch) | |
tree | 6bbbde24e64ac2395033b8a1c1cda8a3e3f7aa58 | |
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>
34 files changed, 124 insertions, 118 deletions
diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml index 1c45179..87c21bb 100644 --- a/appendices/common-problems/text.xml +++ b/appendices/common-problems/text.xml @@ -100,8 +100,8 @@ for security reasons. If this message is shown, you have a couple of options: linking. This solution is preferred. </li> <li> - Use <c>append-ldflags</c> (see <uri - link="::ebuild-writing/functions/src_compile/build-environment#Adding Additional Flags"/>) + Use <c>append-ldflags</c> (see + <uri link="::ebuild-writing/functions/src_compile/build-environment/#Adding Additional Flags"/>) to add <c>-Wl,-z,now</c>. This will affect <e>all</e> binaries installed, not just the setXid ones. </li> </ul> diff --git a/appendices/contributors/text.xml b/appendices/contributors/text.xml index aa101f5..06a6e0c 100644 --- a/appendices/contributors/text.xml +++ b/appendices/contributors/text.xml @@ -16,38 +16,38 @@ This page lists the contributions to the Gentoo Development Guide: <uri link="::tools-reference/cat/#Here Documents"/> </author> <author name="Aaron Walker" email="ka0ttic@gentoo.org"> - <uri link="::tasks-reference/completion"/> + <uri link="::tasks-reference/completion/"/> </author> <author name="Robert Coie" email="rac@gentoo.org"> - <uri link="::appendices/editor-configuration/xemacs"/> + <uri link="::appendices/editor-configuration/xemacs/"/> </author> <author name="Tom Martin" email="slarti@gentoo.org"> - <uri link="::appendices/editor-configuration/emacs"/>, + <uri link="::appendices/editor-configuration/emacs/"/>, <uri link="::general-concepts/use-flags/#Conflicting USE Flags"/> </author> <author name="Paul Varner" email="fuzzyray@gentoo.org"> - <uri link="::ebuild-writing/functions/src_unpack/rpm-sources"/> + <uri link="::ebuild-writing/functions/src_unpack/rpm-sources/"/> </author> <author name="Ilya Volynets-Evenbakh" email="iluxa@gentoo.org"> <uri link="::archs/mips/#MIPS ABIs"/> </author> <author name="Diego Pettenò" email="flameeyes@gentoo.org"> - <uri link="::tasks-reference/pam"/>, + <uri link="::tasks-reference/pam/"/>, <uri link="::general-concepts/autotools/#aclocal and m4 Files"/> </author> <author name="Fernando J. Pereda" email="ferdy@gentoo.org"> - <uri link="::archs/alpha"/> + <uri link="::archs/alpha/"/> </author> <author name="Simon Stelling" email="blubb@gentoo.org"> - <uri link="::archs/amd64"/> + <uri link="::archs/amd64/"/> </author> <author name="Alin Dobre" email="alin@gentoo.org"> - <uri link="::tools-reference/echo"/> + <uri link="::tools-reference/echo/"/> </author> <!-- Contributions above this line were to the original (reStructuredText) version, so they won't appear in the commit history --> <author name="Joseph Jezak" email="josejx@gentoo.org"> - <uri link="::archs/ppc"/> + <uri link="::archs/ppc/"/> </author> <author name="Ursula Maplehurst" email="plasm@roo.me.uk"> Previous maintainer (XSL Stylesheets, legacy Developer Handbook content) @@ -56,9 +56,9 @@ This page lists the contributions to the Gentoo Development Guide: XSL Stylesheets, previous maintainer </author> <author name="Petteri Räty" email="betelgeuse@gentoo.org"> -<uri link="::ebuild-writing"/>, -<uri link="::eclass-writing"/>, -<uri link="::general-concepts/dependencies"/>, +<uri link="::ebuild-writing/"/>, +<uri link="::eclass-writing/"/>, +<uri link="::general-concepts/dependencies/"/>, Misc </author> <author name="Ulrich Müller" email="ulm@gentoo.org"> @@ -71,7 +71,7 @@ Misc DTD, XSL stylesheet, eclass conversion </author> <author name="Mike Pagano" email="mpagano@gentoo.org"> - <uri link="::general-concepts/news"/> + <uri link="::general-concepts/news/"/> </author> <author name="Markus Meier" email="maekke@gentoo.org"> Misc diff --git a/archs/alpha/text.xml b/archs/alpha/text.xml index 9a89adc..32b539b 100644 --- a/archs/alpha/text.xml +++ b/archs/alpha/text.xml @@ -87,7 +87,7 @@ which the compiler was built. <p> The <c>-mieee</c> flag <b>should</b> always be used unless you have a deep knowledge of the Alpha architecture, so the comments on -<uri link="::general-concepts/user-environment#Not Filtering Variables"/> are +<uri link="::general-concepts/user-environment/#Not Filtering Variables"/> are really important on Alpha. </p> diff --git a/archs/sparc/text.xml b/archs/sparc/text.xml index b2a83fb..5cfbdf2 100644 --- a/archs/sparc/text.xml +++ b/archs/sparc/text.xml @@ -55,8 +55,8 @@ buses. <note> This section is in addition to the guidelines in -<uri link="::keywording#Keywording on Upgrades"/>. It discusses <e>additional</e> -requirements for the SPARC architecture. +<uri link="::keywording/#Keywording on Upgrades"/>. It discusses +<e>additional</e> requirements for the SPARC architecture. </note> <p> @@ -116,7 +116,7 @@ code. Depending upon the application, this can be anywhere up to five times slower than <c>v9</c> code when running on an UltraSparc <d/> cryptographic and graphics applications which make heavy use of integer multiplication and division are especially badly hit. For this reason, the comments in -<uri link="::general-concepts/user-environment#Not Filtering Variables"/> +<uri link="::general-concepts/user-environment/#Not Filtering Variables"/> are especially important on SPARC. </p> diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml index 8cdabde..8bef553 100644 --- a/ebuild-maintenance/git/text.xml +++ b/ebuild-maintenance/git/text.xml @@ -292,7 +292,7 @@ are optionally used in Gentoo: </ul> <p> -When committing <uri link="::ebuild-writing/user-submitted">user +When committing <uri link="::ebuild-writing/user-submitted/">user contributions</uri>, make sure to credit them in your commit message with the user's full name and email address. Be aware and respectful of their privacy: some users prefer to be only known by a nickname. diff --git a/ebuild-maintenance/package-moves/text.xml b/ebuild-maintenance/package-moves/text.xml index c91c3dd..eab8848 100644 --- a/ebuild-maintenance/package-moves/text.xml +++ b/ebuild-maintenance/package-moves/text.xml @@ -62,7 +62,7 @@ and update them. These include: <ul> <li> - <uri link="::general-concepts/dependencies">dependencies</uri>, + <uri link="::general-concepts/dependencies/">dependencies</uri>, <c>optfeature.eclass</c> uses, <c>has_version</c> and <c>best_version</c> uses in other ebuilds and eclasses </li> diff --git a/ebuild-maintenance/removal/text.xml b/ebuild-maintenance/removal/text.xml index 5413a06..bdeae71 100644 --- a/ebuild-maintenance/removal/text.xml +++ b/ebuild-maintenance/removal/text.xml @@ -52,7 +52,7 @@ When removing packages follow these steps: <li>Remove package.mask and any package.use.mask entries</li> <li> Remove the <c><pkg></c> tags referencing this package in the - <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> + <uri link="::ebuild-writing/misc-files/metadata/">metadata.xml</uri> files of other packages. </li> <li>Close open bugs as WONTFIX</li> 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> diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 2b3033e..2504c8c 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -9,8 +9,9 @@ This section provides a brief introduction to eclass authoring. </p> <important> -You should reread the <uri link="::general-concepts/overlay#Overlay and Eclasses"/> -and <uri link="::general-concepts/portage-cache"/> sections before continuing. +You should reread the +<uri link="::general-concepts/overlay/#Overlay and Eclasses"/> +and <uri link="::general-concepts/portage-cache/"/> sections before continuing. </important> </body> diff --git a/function-reference/message-functions/text.xml b/function-reference/message-functions/text.xml index 7423496..e5ea04f 100644 --- a/function-reference/message-functions/text.xml +++ b/function-reference/message-functions/text.xml @@ -86,7 +86,7 @@ displaying informational messages. </table> <p> -See <uri link="::ebuild-writing/messages"/> for a detailed discussion. +See <uri link="::ebuild-writing/messages/"/> for a detailed discussion. </p> </body> diff --git a/function-reference/query-functions/text.xml b/function-reference/query-functions/text.xml index 0233e26..077e2cd 100644 --- a/function-reference/query-functions/text.xml +++ b/function-reference/query-functions/text.xml @@ -131,9 +131,8 @@ query variables and similar state. </ti> <ti> True if <c>pkg</c> (can include - <uri link="::general-concepts/dependencies#version specifiers"/> - and - <uri link="::general-concepts/dependencies#built with use dependencies"/>) + <uri link="::general-concepts/dependencies/#version specifiers"/> and + <uri link="::general-concepts/dependencies/#built with use dependencies"/>) is installed. Example: <c>has_version "=app-editors/nano-2.5.3[nls,spell]"</c>. (EAPI=7) An option may also be specified to query certain types of dependencies. diff --git a/function-reference/sandbox-functions/text.xml b/function-reference/sandbox-functions/text.xml index 3cd5ead..ca5df54 100644 --- a/function-reference/sandbox-functions/text.xml +++ b/function-reference/sandbox-functions/text.xml @@ -61,9 +61,10 @@ recursive, so to allow predicted writes to <c>/foo/bar</c> and <c>/foo/baz</c>, </p> <p> -See <uri link="::general-concepts/sandbox"/> for details on how the sandbox works. -See <uri link="::appendices/common-problems/#Handling Access Violations"/> for how -to handle sandbox-related build problems. +See <uri link="::general-concepts/sandbox/"/> for details on how the sandbox +works. +See <uri link="::appendices/common-problems/#Handling Access Violations"/> +for how to handle sandbox-related build problems. </p> </body> diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml index 885fbd6..09162ff 100644 --- a/general-concepts/autotools/text.xml +++ b/general-concepts/autotools/text.xml @@ -5,8 +5,9 @@ <body> <todo> -This is too long for <uri link="::general-concepts"/>. It needs to be split up and -moved somewhere, either to a top-level of its own or into <uri link="::appendices/"/>. +This is too long for <uri link="::general-concepts/"/>. It needs to be split up +and moved somewhere, either to a top-level of its own or into +<uri link="::appendices/"/>. </todo> <p> @@ -495,10 +496,10 @@ This is handled via the macro <c>AC_SUBST(VARNAME)</c> in <c>configure.ac</c>. <p> Sometimes, badly behaved <c>Makefile.am</c> files will override user variables such as <c>CFLAGS</c>. This must not be allowed <d/> see -<uri link="::general-concepts/user-environment#Not Filtering Variables"/>. There -are separate special variables which should be used in these situations <d/> for -setting <c>CFLAGS</c>. for example, a <c>Makefile.am</c> should use <c>AM_CFLAGS</c> so -that user preferences are not ignored. +<uri link="::general-concepts/user-environment/#Not Filtering Variables"/>. +There are separate special variables which should be used in these situations +<d/> for setting <c>CFLAGS</c>. for example, a <c>Makefile.am</c> should use +<c>AM_CFLAGS</c> so that user preferences are not ignored. </p> <p> diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index b041444..98a84d1 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -19,7 +19,7 @@ them if you're not sure. <p> Please also see the following section on -<uri link="::general-concepts/ebuild-revisions"/> +<uri link="::general-concepts/ebuild-revisions/"/> for how dependencies and revisions interact. </p> @@ -74,7 +74,7 @@ distinctions still apply even if it isn't, strictly speaking, cross-compiling. <p> Build dependencies are used to specify any dependencies that are required to unpack, patch, compile, test or install the package (but see -<uri link="::general-concepts/dependencies#Implicit System Dependency"/> for +<uri link="::general-concepts/dependencies/#Implicit System Dependency"/> for exemptions). </p> @@ -382,7 +382,7 @@ DEPEND="qt5? ( ~dev-qt/qtcore-5.15.2:5 ) In <c>EAPI=5</c> and higher, you can use slot operators appended to the package name to declare whether or not your package should be rebuilt after the versions satisfying its runtime dependencies are updated to versions with a different slot -or <uri link="::general-concepts/slotting#Sub-Slots">sub-slot</uri>: +or <uri link="::general-concepts/slotting/#Sub-Slots">sub-slot</uri>: </p> <ul> diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml index b524a4b..8248a6e 100644 --- a/general-concepts/ebuild-revisions/text.xml +++ b/general-concepts/ebuild-revisions/text.xml @@ -6,9 +6,9 @@ <body> <p> Ebuilds may have a Gentoo revision number associated with them. This is a -<c>-rX</c> suffix, where <c>X</c> is an integer <d/> see <uri -link="::ebuild-writing/file-format#File Naming Rules"/>. This -component must only be used for Gentoo changes, not upstream releases. +<c>-rX</c> suffix, where <c>X</c> is an integer <d/> see +<uri link="::ebuild-writing/file-format/#File Naming Rules"/>. +This component must only be used for Gentoo changes, not upstream releases. An ebuild with no explicit revision number has the implicit <c>-r0</c> revision. </p> @@ -40,7 +40,7 @@ of thumb could be used as a guideline: as such), then a new revision should be introduced and the old one kept. If the package has stable keywords, the new revision should be dropped to <c>~arch</c> (see - <uri link="::keywording#Keywording on Upgrades"/>). + <uri link="::keywording/#Keywording on Upgrades"/>). For any such revision bump, the new ebuild should be based on the previous revision to ensure that fixes aren't dropped accidentally. diff --git a/general-concepts/mirrors/text.xml b/general-concepts/mirrors/text.xml index f1ce1bb..f380d45 100644 --- a/general-concepts/mirrors/text.xml +++ b/general-concepts/mirrors/text.xml @@ -41,9 +41,10 @@ This should not be used in new ebuilds. <p> There is also <c>RESTRICT="fetch"</c>, which prevents Portage from trying to -fetch anything manually. The <uri link="::ebuild-writing/functions/pkg_nofetch"> -pkg_nofetch</uri> function will be called if any <c>SRC_URI</c> components -cannot be found. This should only be used if a license requires it. +fetch anything manually. +The <uri link="::ebuild-writing/functions/pkg_nofetch/">pkg_nofetch</uri> +function will be called if any <c>SRC_URI</c> components cannot be found. +This should only be used if a license requires it. </p> </body> </subsection> diff --git a/general-concepts/projects/text.xml b/general-concepts/projects/text.xml index 43741d8..19188d4 100644 --- a/general-concepts/projects/text.xml +++ b/general-concepts/projects/text.xml @@ -21,7 +21,7 @@ form a project hierarchy. <p> A package maintained by a project needs to have the project explicitly listed as a maintainer in its -<uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri>. +<uri link="::ebuild-writing/misc-files/metadata/">metadata.xml</uri>. The full listing of all the projects can be found on <uri link="https://api.gentoo.org/metastructure/projects.xml"> api.gentoo.org</uri> or on the diff --git a/general-concepts/slotting/text.xml b/general-concepts/slotting/text.xml index 05d01c9..9eabf08 100644 --- a/general-concepts/slotting/text.xml +++ b/general-concepts/slotting/text.xml @@ -41,7 +41,7 @@ possible that the user may have <c>foo-2.0</c> installed and no <c>foo-1.x</c> a <p> To <c>DEPEND</c> upon a package in a specific slot, refer to -<uri link="::general-concepts/dependencies#SLOT Dependencies" />. +<uri link="::general-concepts/dependencies/#SLOT Dependencies"/>. </p> </body> @@ -55,7 +55,7 @@ but it's undesirable or inconvenient to allow some of these versions to be insta simultaneously. In <c>EAPI=5</c> and higher, this situation can be handled by using sub-slots, which are delimited from the regular slot by a <c>/</c> character, as in <c>SLOT="slot/subslot"</c>. Packages can -<uri link="::general-concepts/dependencies#Slot Operators">request to be +<uri link="::general-concepts/dependencies/#Slot Operators">request to be automatically rebuilt</uri> when the subslot of a runtime dependency changes. </p> diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml index 6c91eb4..9fb9cb9 100644 --- a/general-concepts/tree/text.xml +++ b/general-concepts/tree/text.xml @@ -41,7 +41,7 @@ The basic layout of the Gentoo repository is as follows: Metadata directory, <c>metadata/</c>. Most of the listed contents are not kept directly in the main git tree but instead auto-generated or included from other repositories as part of the - <uri link="::general-concepts/git-to-rsync">Git to Rsync</uri> + <uri link="::general-concepts/git-to-rsync/">Git to Rsync</uri> process. <ul> <li> diff --git a/profiles/use.desc/text.xml b/profiles/use.desc/text.xml index 39689b9..301c53e 100644 --- a/profiles/use.desc/text.xml +++ b/profiles/use.desc/text.xml @@ -14,7 +14,7 @@ discussion on the <c>gentoo-dev</c> list. The <c>metadata.xml</c> file on each ebuild category contains a list of the local <c>USE</c> flags, together with short description for the package in the said category. More information about the <c>metadata.xml</c> file can be found -<uri link="::ebuild-writing/misc-files/metadata">here.</uri> +<uri link="::ebuild-writing/misc-files/metadata/">here.</uri> </p> <note> @@ -26,7 +26,7 @@ so you must never edit it directly. Having a small number of packages using identically named local <c>USE</c> flags is allowed. If the number starts to grow substantially, it may be worth proposing that the flag becomes a global <d /> see -<uri link="::general-concepts/use-flags#Local and Global USE Flags"/>. +<uri link="::general-concepts/use-flags/#Local and Global USE Flags"/>. </p> <p> diff --git a/quickstart/text.xml b/quickstart/text.xml index 403d29e..c66f4ac 100644 --- a/quickstart/text.xml +++ b/quickstart/text.xml @@ -13,8 +13,9 @@ idea of how ebuilds work. </p> <p> -For proper coverage of all the ins and outs, see <uri link="::ebuild-writing"/>. -The <uri link="::general-concepts"/> chapter will also be of use. +For proper coverage of all the ins and outs, +see <uri link="::ebuild-writing/"/>. +The <uri link="::general-concepts/"/> chapter will also be of use. </p> <p> @@ -73,8 +74,8 @@ At the top of the ebuild is a header block. This is present in all ebuilds. </p> <p> -Ebuilds are indented using tabs, with each tab representing four places. See -<uri link="::ebuild-writing/file-format"/>. +Ebuilds are indented using tabs, with each tab representing four places. +See <uri link="::ebuild-writing/file-format/"/>. </p> </body> </subsection> @@ -89,7 +90,7 @@ the ebuild and package in question. </p> <p> -The <c>EAPI</c> of the ebuild, see <uri link="::ebuild-writing/eapi"/>. +The <c>EAPI</c> of the ebuild, see <uri link="::ebuild-writing/eapi/"/>. </p> <p> @@ -118,14 +119,14 @@ or (at your option) any later version). <p> The <c>SLOT</c> variable tells Portage which slot this package installs to. If you've not seen slots before, either just use <c>"0"</c> or read -<uri link="::general-concepts/slotting"/>. +<uri link="::general-concepts/slotting/"/>. </p> <p> The <c>KEYWORDS</c> variable is set to archs upon which this ebuild has been tested. We use <c>~</c> keywords for newly written ebuilds <d/> packages are not -committed straight to stable, even if they seem to work. See <uri link="::keywording"/> for -details. +committed straight to stable, even if they seem to work. +See <uri link="::keywording/"/> for details. </p> </body> </subsection> @@ -147,8 +148,8 @@ The <c>src_install</c> function is called by Portage when it wants to <e>install</e> the package. A slight subtlety here <d/> rather than installing straight to the live filesystem, we must install to a special location which is given by the <c>${D}</c> variable (Portage sets -this <d/> see <uri link="::general-concepts/install-destinations"/> and -<uri link="::general-concepts/sandbox"/>). +this <d/> see <uri link="::general-concepts/install-destinations/"/> and +<uri link="::general-concepts/sandbox/"/>). </p> <note> @@ -164,7 +165,8 @@ files into the relevant part of <c>/usr/share/doc</c>. </p> <p> -Ebuilds can define other functions (see <uri link="::ebuild-writing/functions"/>). +Ebuilds can define other functions +(see <uri link="::ebuild-writing/functions/"/>). In all cases, Portage provides a reasonable default implementation which quite often does the 'right thing'. There was no need to define <c>src_unpack</c> and <c>src_compile</c> functions here, for example @@ -193,7 +195,7 @@ failed. <p> In the ctags example, we didn't tell Portage about any dependencies. As it happens, that's ok, because ctags only needs a basic toolchain to compile and -run (see <uri link="::general-concepts/dependencies#Implicit System Dependency"/> +run (see <uri link="::general-concepts/dependencies/#Implicit System Dependency"/> for why we don't need to depend upon those explicitly). However, life is rarely that simple. </p> @@ -231,7 +233,7 @@ Again, you can see the ebuild header and the various informational variables. In <c>SRC_URI</c>, <c>${PN}</c> is used to get the package's name <e>without</e> the version suffix (there are more of these variables <d/> see -<uri link="::ebuild-writing/variables#Predefined Read-Only Variables"/>). +<uri link="::ebuild-writing/variables/#Predefined Read-Only Variables"/>). </p> <p> @@ -245,7 +247,7 @@ The <c>BDEPEND</c>, <c>DEPEND</c>, and <c>RDEPEND</c> variables are how Portage determines which packages are needed to build and run the package. The <c>BDEPEND</c> variable lists build-time (executable) dependencies, <c>DEPEND</c> variable lists compile-time dependencies, and the <c>RDEPEND</c> -lists runtime dependencies. See <uri link="::general-concepts/dependencies"/> +lists runtime dependencies. See <uri link="::general-concepts/dependencies/"/> for some more complex examples. </p> @@ -298,8 +300,8 @@ Note the <c>${FILESDIR}/${P}-destdir.patch</c> <d/> this refers to <c>detox-1.1.0-destdir.patch</c>, which lives in the <c>files/</c> subdirectory in the Gentoo repository. Larger patch files must go on your developer's space at <c>dev.gentoo.org</c> rather than in <c>files/</c> or -mirrors <d/> see <uri link="::general-concepts/mirrors#Gentoo Mirrors"/> and <uri -link="::ebuild-writing/functions/src_prepare/epatch/"/>. +mirrors <d/> see <uri link="::general-concepts/mirrors/#Gentoo Mirrors"/> and +<uri link="::ebuild-writing/functions/src_prepare/epatch/"/>. </p> <p> diff --git a/tools-reference/diff-and-patch/text.xml b/tools-reference/diff-and-patch/text.xml index 50983b6..0e9755c 100644 --- a/tools-reference/diff-and-patch/text.xml +++ b/tools-reference/diff-and-patch/text.xml @@ -31,7 +31,7 @@ upstream too <d/> however, occasionally you may be asked to provide context diffs, which are more portable than unifieds (but don't handle conflicts as cleanly). In this case, use <c>-c</c> rather than <c>-u</c>. For a verbose guide into patches and patching, see -<uri link="::ebuild-writing/misc-files/patches"/>. +<uri link="::ebuild-writing/misc-files/patches/"/>. </p> <p> @@ -40,7 +40,7 @@ where <c>X</c> is a number representing the number of path components which must be removed (typically this is <c>0</c> or <c>1</c>). Within ebuilds, use the <c>epatch</c> function, or <c>eapply</c> function beginning with EAPI=6, instead — see -<uri link="::ebuild-writing/functions/src_prepare/epatch"/>. +<uri link="::ebuild-writing/functions/src_prepare/epatch/"/>. </p> <p> |