QA Notice <d/> USE Flag foo not in IUSE

From 076c949b6d901e7678a3d64efd1b9b1a2cb19299 Mon Sep 17 00:00:00 2001 From: Mark Loeser Date: Wed, 3 May 2006 06:23:06 +0000 Subject: All of the URLs should work now except for ebuild-writing/file-format/'s reference to glep31check since all of the tool pages weren't added yet (I thought they were) git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@39 176d3534-300d-0410-8db8-84e73ed771c3 --- appendices/common-problems/text.xml | 45 ++++++++++++---------- appendices/contributing/text.xml | 2 +- ebuild-writing/error-handling/text.xml | 3 +- .../src_compile/build-environment/text.xml | 5 ++- .../functions/src_compile/building/text.xml | 2 +- .../functions/src_unpack/svn-sources/text.xml | 12 +++--- ebuild-writing/messages/text.xml | 2 +- ebuild-writing/use-conditional-code/text.xml | 2 +- ebuild-writing/using-eclasses/text.xml | 12 +++--- ebuild-writing/variables/text.xml | 4 +- eclass-reference/eutils.eclass/text.xml | 8 ++-- eclass-reference/text.xml | 2 +- function-reference/sandbox-functions/text.xml | 3 +- general-concepts/autotools/text.xml | 2 +- general-concepts/overlay/text.xml | 6 ++- general-concepts/sandbox/text.xml | 7 ++-- general-concepts/use-flags/text.xml | 2 +- profiles/categories/text.xml | 4 +- profiles/package.mask/text.xml | 2 +- profiles/text.xml | 2 +- profiles/use.mask/text.xml | 2 +- quickstart/text.xml | 10 +++-- tasks-reference/completion/text.xml | 6 +-- tasks-reference/environment/text.xml | 4 +- tasks-reference/init-scripts/text.xml | 8 ++-- tools-reference/bash/text.xml | 13 ++++--- 26 files changed, 93 insertions(+), 77 deletions(-) diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml index 35b642d..b9d6afa 100644 --- a/appendices/common-problems/text.xml +++ b/appendices/common-problems/text.xml @@ -26,20 +26,21 @@ covered here. -QA Notice <d/> USE Flag foo not in IUSE +QA Notice -- USE Flag foo not in IUSE

With the exception of 'special' flags (the arch flags and USE_EXPAND variables), all USE flags used by a package must be included in IUSE. -See `IUSE`_ and `USE Flags`_. +See and +.

-QA Notice <d/> foo in global scope +QA Notice -- foo in global scope

@@ -57,8 +58,9 @@ in use, there are various alternatives: Usually when any of the above are used in global scope, it is to manipulate a version or program name string. These should be avoided in favour of pure bash constructs. The versionator eclass is often of use here. - See `Version Formatting Issues`_, `versionator.eclass-5`_ and `Bash Variable - Manipulation`_. + See , + man versionator.eclass and .

@@ -67,9 +69,9 @@ in use, there are various alternatives:

Calls to any of these globally indicates a serious problem. You must not - have metadata varying based upon system-dependent information see `The - Portage Cache`_. You should rewrite your ebuilds to correctly use - dependencies. + have metadata varying based upon system-dependent information see + . You should rewrite your ebuilds + to correctly use dependencies.

@@ -89,7 +91,7 @@ in use, there are various alternatives: -QA Notice <d/> foo is setXid, dynamically linked and using lazy bindings +QA Notice -- foo is setXid, dynamically linked and using lazy bindings

@@ -103,8 +105,9 @@ for security reasons. If this message is shown, you have a couple of options: linking. This solution is preferred.

- Use append-ldflags (see `Adding Additional Flags`_) to add -Wl,-z,now. - This will affect all binaries installed, not just the setXid ones. + Use append-ldflags (see ) + to add -Wl,-z,now. This will affect all binaries installed, not just the setXid ones.

@@ -112,13 +115,13 @@ for security reasons. If this message is shown, you have a couple of options: -QA Notice <d/> ECLASS foo inherited illegally +QA Notice -- ECLASS foo inherited illegally

All eclass inherits must be unconditional, or based purely upon static -machine-independent criteria (PN and PV are most common here). See `The -Portage Cache`_. +machine-independent criteria (PN and PV are most common here). See +.

@@ -132,8 +135,8 @@ inheritance occurring. Most commonly: did not record inheritance.

- When working with eclasses in an overlay with a stale cache. See `Overlay and - Eclasses`_. + When working with eclasses in an overlay with a stale cache. See .

When working with a stale portage cache. @@ -141,7 +144,8 @@ inheritance occurring. Most commonly:

-You should manually check against the rules described in `The Portage Cache`_ if +You should manually check against the rules described in + if you see this notice locally. If you see this notice when working with a pure emerge sync over rsync setup, it is probably a genuine issue.

@@ -180,8 +184,8 @@ write me

Portage uses a sandbox for certain phases of the build process. This prevents a -package from accidentally writing outside 'safe' locations. See `Sandbox`_ for -details. +package from accidentally writing outside 'safe' locations. See + for details.

@@ -211,7 +215,8 @@ ebuilds.

Access violations most commonly occur during the install phase. See -src_install and `Install Destinations`_ for discussion. +src_install and +for discussion.

diff --git a/appendices/contributing/text.xml b/appendices/contributing/text.xml index 6262a5c..3d327b3 100644 --- a/appendices/contributing/text.xml +++ b/appendices/contributing/text.xml @@ -6,7 +6,7 @@

Contributions for this document are highly welcomed. Whether you've found a typo -or have written an entire new section, the best way to get in touch is to `send +or have written an entire new section, the best way to get in touch is to send an email to plasmaroo.

diff --git a/ebuild-writing/error-handling/text.xml b/ebuild-writing/error-handling/text.xml index 3e4c887..9382d04 100644 --- a/ebuild-writing/error-handling/text.xml +++ b/ebuild-writing/error-handling/text.xml @@ -96,7 +96,8 @@ cat list | while read file ; do epatch ${file} ; done

-Using input redirection (see `Abuse of cat`_) avoids this problem: +Using input redirection (see ) +avoids this problem:

diff --git a/ebuild-writing/functions/src_compile/build-environment/text.xml b/ebuild-writing/functions/src_compile/build-environment/text.xml index c2ec07e..24a4bfa 100644 --- a/ebuild-writing/functions/src_compile/build-environment/text.xml +++ b/ebuild-writing/functions/src_compile/build-environment/text.xml @@ -17,7 +17,8 @@ Except where otherwise specified, any function which operates on

-Ebuilds must not simply ignore use CFLAGS see . +Ebuilds must not simply ignore use CFLAGS see +.

@@ -140,7 +141,7 @@ functions can be used here.

-See `flag-o-matic.eclass Reference`_ for a full reference. +See for a full reference.

diff --git a/ebuild-writing/functions/src_compile/building/text.xml b/ebuild-writing/functions/src_compile/building/text.xml index 171429e..621e51c 100644 --- a/ebuild-writing/functions/src_compile/building/text.xml +++ b/ebuild-writing/functions/src_compile/building/text.xml @@ -35,7 +35,7 @@ some MIPS and SPARC systems. Sometimes a package will try to use a bizarre compiler, or will need to be told which compiler to use. In these situations, the tc-getCC() function from toolchain-funcs.eclass should be used. Other similar functions are available - these are documented in `toolchain-funcs.eclass-5`_. + these are documented in man toolchain-funcs.eclass.

diff --git a/ebuild-writing/functions/src_unpack/svn-sources/text.xml b/ebuild-writing/functions/src_unpack/svn-sources/text.xml index 06f17e8..c23ff7c 100644 --- a/ebuild-writing/functions/src_unpack/svn-sources/text.xml +++ b/ebuild-writing/functions/src_unpack/svn-sources/text.xml @@ -6,8 +6,8 @@

As with CVS, an eclass exists for working directly with upstream -Subversion repositories. See `subversion.eclass Reference`_ for a full -list of functions and variables. Also see +Subversion repositories. See +for a full list of functions and variables. Also see the ection.

@@ -21,8 +21,8 @@ ection. Note that Subversion ebuilds should not generally be added to the tree (except under package.mask) for much the same reasons that live CVS ebuilds should not (see -). Indeed, there should be even less -impetus to add a live Subversion ebuild than a live CVS ebuild, as +). +Indeed, there should be even less impetus to add a live Subversion ebuild than a live CVS ebuild, as Subversion checkouts are roughly a factor of five larger than an equivalent CVS checkout.

@@ -82,8 +82,8 @@ following variables are also noteworthy:

-See the eclass itself and `subversion.eclass Reference`_ for the full -range of options. To perform the actual checkout, use +See the eclass itself and +for the full range of options. To perform the actual checkout, use the subversion_src_unpack function, which calls both subversion_svn_fetch and subversion_bootstrap itself. diff --git a/ebuild-writing/messages/text.xml b/ebuild-writing/messages/text.xml index de3c476..65c3c1e 100644 --- a/ebuild-writing/messages/text.xml +++ b/ebuild-writing/messages/text.xml @@ -98,7 +98,7 @@ important.

-See `Message Functions Reference`_ for a full list of functions. +See for a full list of functions.

diff --git a/ebuild-writing/use-conditional-code/text.xml b/ebuild-writing/use-conditional-code/text.xml index 79d580b..d9a1b8b 100644 --- a/ebuild-writing/use-conditional-code/text.xml +++ b/ebuild-writing/use-conditional-code/text.xml @@ -21,7 +21,7 @@ occasionally seen in older code must not be used. die will not work as expected within a subshell, so code in the form use foo && ( blah ; blah ) should be avoided in favour of a proper if -statement. See `die and Subshells`_. +statement. See . diff --git a/ebuild-writing/using-eclasses/text.xml b/ebuild-writing/using-eclasses/text.xml index ddd2b9c..e9b7a42 100644 --- a/ebuild-writing/using-eclasses/text.xml +++ b/ebuild-writing/using-eclasses/text.xml @@ -7,7 +7,7 @@

An eclass is a collection (library) of functions or functionality that is shared between packages. See for the full story on what -eclasses can do, how they work and how to write them, and `Eclass Reference`_ +eclasses can do, how they work and how to write them, and for documentation on various commonly used eclasses. This section only explains how to use an eclass which has already been written.

@@ -84,11 +84,11 @@ Note the inherit immediately after the header.

-The eutils eclass (see `eutils.eclass Reference`_) is needed to get the -epatch function. The flag-o-matic eclass (see `flag-o-matic.eclass -Reference`_) is needed for replace-flags, and the bash-completion eclass -(`bash-completion.eclass Reference`_) is used to handle the bash completion file -via dobashcompletion and bash-completion_pkg_postinst. +The eutils eclass (see ) is needed to get the +epatch function. The flag-o-matic eclass (see ) is needed for replace-flags, and +the bash-completion eclass () is used +to handle the bash completion file via dobashcompletion and bash-completion_pkg_postinst.

diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml index 1e68bef..d290676 100644 --- a/ebuild-writing/variables/text.xml +++ b/ebuild-writing/variables/text.xml @@ -217,7 +217,7 @@ Specifying the following variables is optional: A space-delimited list of portage features to restrict. Valid values are nostrip, nomirror, nouserpriv - and fetch. See `ebuild-5`_ for details. + and fetch. See man ebuild for details. @@ -379,7 +379,7 @@ highly discouraged.

The versionator eclass can also be used to extract particular components -from a version string. See `versionator.eclass-5`_ and the eclass source code +from a version string. See man versionator.eclass and the eclass source code for further documentation and examples. A brief summary of the functions follows.

diff --git a/eclass-reference/eutils.eclass/text.xml b/eclass-reference/eutils.eclass/text.xml index 256a81c..effdf25 100644 --- a/eclass-reference/eutils.eclass/text.xml +++ b/eclass-reference/eutils.eclass/text.xml @@ -6,7 +6,7 @@

The eutils eclass provides various useful functions. For full documentation, -see `eutils.eclass-5`_. +see man eutils.eclass.

@@ -59,7 +59,7 @@ see `eutils.eclass-5`_. epatch - Apply a patch (see `eutils.eclass-5`_ and + Apply a patch (see man eutils.eclass and ). @@ -168,7 +168,7 @@ see `eutils.eclass-5`_. cdrom_get_cds - See `eutils.eclass-5`_. + See man eutils.eclass. @@ -176,7 +176,7 @@ see `eutils.eclass-5`_. cdrom_load_next_cd - See `eutils.eclass-5`_. + See man eutils.eclass. diff --git a/eclass-reference/text.xml b/eclass-reference/text.xml index fb03dbd..2e3b034 100644 --- a/eclass-reference/text.xml +++ b/eclass-reference/text.xml @@ -6,7 +6,7 @@

This section provides a reference for some of the more commonly used eclasses. -Note that most eclasses have an accompanying manual page -- see `Manual Pages`_. +Note that most eclasses have an accompanying manual page.

diff --git a/function-reference/sandbox-functions/text.xml b/function-reference/sandbox-functions/text.xml index 557210f..f80b2c6 100644 --- a/function-reference/sandbox-functions/text.xml +++ b/function-reference/sandbox-functions/text.xml @@ -62,7 +62,8 @@ recursive, so to allow predicted writes to /foo/bar and /foo/baz,

See for details on how the sandbox works. -See `Handling Access Violations`_ for how to handle sandbox-related build problems. +See for how +to handle sandbox-related build problems.

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml index 7bf1739..b1627e3 100644 --- a/general-concepts/autotools/text.xml +++ b/general-concepts/autotools/text.xml @@ -6,7 +6,7 @@ This is too long for . It needs to be split up and -moved somewhere, either to a top-level of its own or into `Appendices`_. +moved somewhere, either to a top-level of its own or into .

diff --git a/general-concepts/overlay/text.xml b/general-concepts/overlay/text.xml index e823f3a..adffd86 100644 --- a/general-concepts/overlay/text.xml +++ b/general-concepts/overlay/text.xml @@ -42,8 +42,10 @@ Be very careful when using eclasses in an overlay. Portage will not do cache updates when an overlay eclass is changed, nor will it do cache updates when a main portage tree eclass which is used by an overlay ebuild changes. You may also encounter bogus 'illegal inherit' notices when working with eclasses in -overlay (see `QA Notice ECLASS foo inherited illegally`_). To be safe, -manually touch all relevant overlay files after updating overlay eclasses. +overlay (see ). +To be safe, manually touch all relevant overlay files after updating overlay +eclasses.

diff --git a/general-concepts/sandbox/text.xml b/general-concepts/sandbox/text.xml index 216be0d..8fd63a4 100644 --- a/general-concepts/sandbox/text.xml +++ b/general-concepts/sandbox/text.xml @@ -20,9 +20,10 @@ generally not the correct solution.

-See `Sandbox Functions Reference`_ for details on sandbox-related functions. See -`Handling Access Violations`_ for suggestions on fixing sandbox-related build -problems. +See for details on +sandbox-related functions. See for suggestions +on fixing sandbox-related build problems.

diff --git a/general-concepts/use-flags/text.xml b/general-concepts/use-flags/text.xml index 858aaec..9c84573 100644 --- a/general-concepts/use-flags/text.xml +++ b/general-concepts/use-flags/text.xml @@ -148,7 +148,7 @@ mailing list.

All USE flags (excluding USE_EXPAND flags) must be described in either use.desc or use.local.desc in the profiles/ directory. See -`portage-5`_ or the comments in these files for an explanation of the format. +man portage or the comments in these files for an explanation of the format. Remember to keep these files sorted.

diff --git a/profiles/categories/text.xml b/profiles/categories/text.xml index a2a4625..c04c1c1 100644 --- a/profiles/categories/text.xml +++ b/profiles/categories/text.xml @@ -11,8 +11,8 @@ to update and commit this file before making any related commits.

-The categories file is a straight list. For descriptions, see `Category -Metadata`_. +The categories file is a straight list. For descriptions, see .

diff --git a/profiles/package.mask/text.xml b/profiles/package.mask/text.xml index 577c12b..ef57b28 100644 --- a/profiles/package.mask/text.xml +++ b/profiles/package.mask/text.xml @@ -8,7 +8,7 @@ The package.mask file can be used to hard mask packages or certain versions of packages. This is often used when adding certain experimental (either in ebuild or upstream terms) packages to the tree. The format is described in -`portage-5`_. +man portage.

diff --git a/profiles/text.xml b/profiles/text.xml index 44b7774..a8e6e2a 100644 --- a/profiles/text.xml +++ b/profiles/text.xml @@ -6,7 +6,7 @@

This section provides details on the profiles/ directory. All of these files -are also documented in `portage-5`_. +are also documented in man portage.

diff --git a/profiles/use.mask/text.xml b/profiles/use.mask/text.xml index 2effe8b..180da2e 100644 --- a/profiles/use.mask/text.xml +++ b/profiles/use.mask/text.xml @@ -36,7 +36,7 @@ Updates to use.mask should be handled via the relevant arch team.

-See `noblah USE Flags`_ for more discussion. +See for more discussion.

diff --git a/quickstart/text.xml b/quickstart/text.xml index 29e5077..883925e 100644 --- a/quickstart/text.xml +++ b/quickstart/text.xml @@ -155,8 +155,9 @@ for errors. The canonical install method is make DESTDIR="${D}" install. This will work with any properly written standard Makefile. If this gives sandbox errors, try einstall -instead. If this still fails, see `src_install`_ for how to do -manual installs. +instead. If this still fails, see for how to do manual +installs.

@@ -301,7 +302,8 @@ src_install() { Note the ${FILESDIR}/${P}-destdir.patch this refers to detox-1.1.0-destdir.patch, which lives in the files/ subdirectory in the portage tree. Larger patch files must go on the -mirrors rather than in files/ see `Basic epatch Usage`_. +mirrors rather than in files/ see .

@@ -351,7 +353,7 @@ by the ebuild. This is used for the emerge -pv output, amongst other thin

The package's ./configure script takes the usual --enable-nls or --disable-nls argument. We use the use_enable utility function to -generate this automatically (see `Query Functions Reference`_). +generate this automatically (see ).

diff --git a/tasks-reference/completion/text.xml b/tasks-reference/completion/text.xml index dec64ac..a04858d 100644 --- a/tasks-reference/completion/text.xml +++ b/tasks-reference/completion/text.xml @@ -7,8 +7,8 @@

Since v2.05a, bash has offered intelligent programmable completion. Writing such completions for your own programs/things you maintain is relatively easy -provided you know bash already. See `bash-completion.eclass Reference`_ for how -to install completion files. +provided you know bash already. See +for how to install completion files.

@@ -94,7 +94,7 @@ are subsequently reset.

-See `bash-1`_ for a full description of these builtins and their options. +See man bash for a full description of these builtins and their options.

diff --git a/tasks-reference/environment/text.xml b/tasks-reference/environment/text.xml index f6eea7a..be30bf8 100644 --- a/tasks-reference/environment/text.xml +++ b/tasks-reference/environment/text.xml @@ -17,8 +17,8 @@ This directory should only be used for setting environment variables.

To install a file into this directory, use doenvd or newenvd (see -`Install Functions Reference`_). The format of the file should be a series of -lines in the form VARIABLE="the value". +). The format of the file +should be a series of lines in the form VARIABLE="the value".

diff --git a/tasks-reference/init-scripts/text.xml b/tasks-reference/init-scripts/text.xml index 4a4fba8..51df865 100644 --- a/tasks-reference/init-scripts/text.xml +++ b/tasks-reference/init-scripts/text.xml @@ -7,10 +7,10 @@

Init scripts should be installed into /etc/init.d using the doinitd or -newinitd functions (see `Install Functions Reference`_). Any configuration -(commandline parameters or environment variables) for these scripts should be -handled via entries in /etc/conf.d with the same filename doconfd or -newconfd can be used to install these. +newinitd functions (see ). +Any configuration (commandline parameters or environment variables) for these scripts +should be handled via entries in /etc/conf.d with the same filename +doconfd or newconfd can be used to install these.

diff --git a/tools-reference/bash/text.xml b/tools-reference/bash/text.xml index 69e68ca..6e17ca5 100644 --- a/tools-reference/bash/text.xml +++ b/tools-reference/bash/text.xml @@ -320,7 +320,7 @@ following are available:

The general form of a file test is -operator "filename". The following are -available (lifted from `bash-1`_): +available (lifted from man bash):

@@ -511,7 +511,7 @@ available (lifted from `bash-1`_):

The general form of a file comparison is "file1" -operator "file2". The -following are available (lifted from `bash-1`_): +following are available (lifted from man bash):

@@ -669,7 +669,8 @@ done < some_file

-See `die and Subshells`_ for an explanation of why while read < file should +See +for an explanation of why while read < file should be used over cat file | while read.

@@ -824,10 +825,12 @@ with the first match of pattern replaced with replacement. To repl

-`bash-1`_ incorrectly describes what will be matched. Of all the possible +man bash incorrectly describes what will be matched. Of all the possible leftmost matches, the longest will be taken. Yes, really, the longest, even if it involves favouring later groups or later branches. This is not like -perl or sed. See `IEEE1003.1-2004-9.1`_ for details. +perl or sed. See +IEEE1003.1-2004-9.1 for details.

-- cgit v1.2.3-65-gdbad