aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Loeser <halcy0n@gentoo.org>2006-03-05 07:59:36 +0000
committerMark Loeser <halcy0n@gentoo.org>2006-03-05 07:59:36 +0000
commit76bfe0825e5b1c547bc1aa32cfb322fb30803999 (patch)
treea0d6687d5c71068a7bf7d7ff6b3adc2e47e82ebd
parentComplete src_unpack. (diff)
downloaddevmanual-76bfe0825e5b1c547bc1aa32cfb322fb30803999.tar.gz
devmanual-76bfe0825e5b1c547bc1aa32cfb322fb30803999.tar.bz2
devmanual-76bfe0825e5b1c547bc1aa32cfb322fb30803999.zip
Add uri's where we can right now
git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@14 176d3534-300d-0410-8db8-84e73ed771c3
-rw-r--r--ebuild-writing/error-handling/text.xml2
-rw-r--r--ebuild-writing/file-format/text.xml5
-rw-r--r--ebuild-writing/variables/text.xml28
-rw-r--r--general-concepts/autotools/text.xml27
-rw-r--r--general-concepts/dependencies/text.xml8
-rw-r--r--general-concepts/ebuild-revisions/text.xml3
-rw-r--r--general-concepts/filesystem/text.xml6
-rw-r--r--general-concepts/mirrors/text.xml3
-rw-r--r--general-concepts/use-flags/text.xml5
-rw-r--r--quickstart/text.xml33
10 files changed, 72 insertions, 48 deletions
diff --git a/ebuild-writing/error-handling/text.xml b/ebuild-writing/error-handling/text.xml
index 7931311..3e4c887 100644
--- a/ebuild-writing/error-handling/text.xml
+++ b/ebuild-writing/error-handling/text.xml
@@ -54,7 +54,7 @@ not. It is safe to omit the <c>|| die</c> after a call to <c>epatch</c>, but not
<p>
Sometimes displaying additional error information beforehand can be useful. Use
-<c>eerror</c> to do this. See `Messages`_.
+<c>eerror</c> to do this. See <uri link="::ebuild-writing/messages"/>.
</p>
</body>
diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 8fc0db6..51eca56 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -141,8 +141,9 @@ positions wide, and multibyte characters are just one position wide.
<body>
<p>
All ebuilds (and eclasses, metadata files and ChangeLogs) must use the
-UTF-8 character set. See `GLEP 31`_ for details, and `glep31check`_
-for an easy way of checking for validity.
+UTF-8 character set. See <uri
+link="http://www.gentoo.org/proj/en/glep/glep-0031.html">GLEP 31</uri>
+for details, and `glep31check`_ for an easy way of checking for validity.
</p>
</body>
</section>
diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml
index a13202a..b466536 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -125,7 +125,8 @@ The following variables must be defined by every ebuild.
<ti><c>SRC_URI</c></ti>
<ti>
A list of source URIs for the package. Can contain
- <c>USE</c>-conditional parts, see `SRC_URI`_.
+ <c>USE</c>-conditional parts, see
+ <uri link="::ebuild-writing/variables#SRC_URI"/>.
</ti>
</tr>
<tr>
@@ -134,24 +135,32 @@ The following variables must be defined by every ebuild.
</tr>
<tr>
<ti><c>KEYWORDS</c></ti>
- <ti>See `KEYWORDS`_ and `Keywording`_.</ti>
+ <ti>
+ See <uri link="::ebuild-writing/variables#KEYWORDS"/> and
+ `Keywording`_.
+ </ti>
</tr>
<tr>
<ti><c>SLOT</c></ti>
- <ti>The package's <c>SLOT</c>. See `SLOT`_.</ti>
+ <ti>
+ The package's <c>SLOT</c>. See
+ <uri link="::ebuild-writing/variables#SLOT"/>.
+ </ti>
</tr>
<tr>
<ti><c>LICENSE</c></ti>
<ti>
The package's license, corresponding exactly (including
- case) to a file in <c>licenses/</c>. See `LICENSE`_.
+ case) to a file in <c>licenses/</c>. See
+ <uri link="::ebuild-writing/variables#LICENSE"/>.
</ti>
</tr>
<tr>
<ti><c>IUSE</c></ti>
<ti>
A list of all <c>USE</c> flags (excluding arch and auto
- expand flags) used within the ebuild. See `IUSE`_.
+ expand flags) used within the ebuild. See
+ <uri link="::ebuild-writing/variables#IUSE"/>.
</ti>
</tr>
</table>
@@ -185,14 +194,14 @@ Specifying the following variables is optional:
<ti><c>DEPEND</c></ti>
<ti>
A list of the package's build dependencies. See
- `Dependencies`_.
+ <uri link="::general-concepts/dependencies"/>.
</ti>
</tr>
<tr>
<ti><c>RDEPEND</c></ti>
<ti>
A list of the package's runtime dependencies. See
- `Dependencies`_.
+ <uri link="::general-concepts/dependencies"/>.
</ti>
</tr>
<tr>
@@ -200,7 +209,7 @@ Specifying the following variables is optional:
<ti>
A list of packages to be installed after the package
is merged. Should only be used where <c>RDEPEND</c> is not
- possible. See `Dependencies`_.
+ possible. See <uri link="::general-concepts/dependencies"/>.
</ti>
</tr>
<tr>
@@ -324,7 +333,8 @@ listed. Neither should auto-expand flags (<c>linguas_en</c> and so on).
<p>
It is possible to specify multiple <c>LICENSE</c> entries, and entries which only
apply if a particular <c>USE</c> flag is set. The format is the same as for
-<c>DEPEND</c>. See `GLEP 23`_ for details.
+<c>DEPEND</c>. See <uri link="http://www.gentoo.org/proj/en/glep/glep-0023.html">
+GLEP 23</uri> for details.
</p>
</body>
diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 6224ebd..7bf1739 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -5,7 +5,7 @@
<body>
<todo>
-This is too long for `General Concepts`_. It needs to be split up and
+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 `Appendices`_.
</todo>
@@ -134,7 +134,8 @@ src_compile() {
<p>
The <c>einfo</c> 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 `Messages`_.
+to let the user know that something is still happening. See
+<uri link="::ebuild-writing/messages"/>.
</p>
</body>
@@ -490,7 +491,8 @@ 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 `Not Filtering Variables`_. There
+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.
@@ -638,7 +640,7 @@ For more details on autotools:
The book "GNU Autoconf, Automake and Libtool" by Gary V. Vaughan, Ben
Elliston, Tom Tromey and Ian Lance Taylor (often called "The Autobook")
provides a good but somewhat outdated description of autotools. It is
- `freely available online &lt;http://sources.redhat.com/autobook/&gt;`_.
+ <uri link="http://sources.redhat.com/autobook/">freely available online</uri>.
</li>
<li>
The GNU documentation for the various autotools components is of varying
@@ -646,23 +648,24 @@ For more details on autotools:
</li>
<ul>
<li>
- `GNU automake Manual
- &lt;http://www.gnu.org/software/automake/manual/automake.html&gt;`_
+ <uri link="http://www.gnu.org/software/automake/manual/automake.html">
+ GNU automake Manual
+ </uri>
</li>
<li>
- `GNU autoconf Manual &lt;http://www.gnu.org/software/autoconf/manual/&gt;`_
+ <uri link="http://www.gnu.org/software/autoconf/manual/">GNU autoconf Manual</uri>
</li>
<li>
- `GNU libtool Manual &lt;http://www.gnu.org/software/libtool/manual.html&gt;`_
+ <uri link="http://www.gnu.org/software/libtool/manual.html">GNU libtool Manual</uri>
</li>
<li>
- `GNU m4 Manual &lt;http://www.gnu.org/software/m4/manual/m4.html&gt;`_
+ <uri link="http://www.gnu.org/software/m4/manual/m4.html">GNU m4 Manual</uri>
</li>
</ul>
<li>
- There are some good overview lectures available online. `These slides
- &lt;http://vipe.technion.ac.il/~shlomif/lecture/Autotools/slides/&gt;`_ are one
- example.
+ There are some good overview lectures available online. <uri
+ link="http://vipe.technion.ac.il/~shlomif/lecture/Autotools/slides/">These
+ slides</uri> are one example.
</li>
</ul>
diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml
index 90d5795..d57d48a 100644
--- a/general-concepts/dependencies/text.xml
+++ b/general-concepts/dependencies/text.xml
@@ -17,7 +17,8 @@
<p>
The <c>DEPEND</c> ebuild variable should specify any dependencies which are
required to unpack, patch, compile or install the package (but see
-`Implicit System Dependency`_ for exemptions).
+<uri link="::general-concepts/dependencies#Implicit System Dependency"/> for
+exemptions).
</p>
</body>
@@ -293,8 +294,9 @@ To depend upon a virtual package, use <c>virtual/whatever</c> as the atom.
</p>
<p>
-Currently, you must not use any kind of version specification with virtuals --
-see `GLEP 37`_ for details and a proposed solution.
+Currently, you must not use any kind of version specification with virtuals <d/>
+see <uri link="http://www.gentoo.org/proj/en/glep/glep-0037.html">GLEP 37</uri>
+for details and a proposed solution.
</p>
</body>
diff --git a/general-concepts/ebuild-revisions/text.xml b/general-concepts/ebuild-revisions/text.xml
index 33b7de1..bcc472e 100644
--- a/general-concepts/ebuild-revisions/text.xml
+++ b/general-concepts/ebuild-revisions/text.xml
@@ -6,7 +6,8 @@
<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 `File Naming Rules`_. This
+<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. By
default, <c>-r0</c> is implied and should not be specified manually.
</p>
diff --git a/general-concepts/filesystem/text.xml b/general-concepts/filesystem/text.xml
index 64f9ac4..4a26753 100644
--- a/general-concepts/filesystem/text.xml
+++ b/general-concepts/filesystem/text.xml
@@ -69,9 +69,9 @@ to <c>/usr/share</c>.
<body>
<p>
-Gentoo does not consider the `Filesystem Hierarchy Standard
-http://www.pathname.com/fhs/`__ to be an authoritative standard, although much
-of our policy coincides with it.
+Gentoo does not consider the <uri link="http://www.pathname.com/fhs/">
+Filesystem Hierarchy Standard</uri> to be an authoritative standard, although
+much of our policy coincides with it.
</p>
</body>
diff --git a/general-concepts/mirrors/text.xml b/general-concepts/mirrors/text.xml
index dbbd855..b3cae8c 100644
--- a/general-concepts/mirrors/text.xml
+++ b/general-concepts/mirrors/text.xml
@@ -66,7 +66,8 @@ Instead, these files must be moved onto <c>mirror://gentoo</c> before release.
To manually upload a file to <c>mirror://gentoo</c>, <c>scp</c> it to
<c>dev.gentoo.org:/space/distfiles-local</c>. You must ensure that the permissions
are set to <c>ug+rw</c> manually. The file should appear on the mirrors within four
-hours (note that this is <e>less frequent</e> than `CVS to rsync`_).
+hours (note that this is <e>less frequent</e> than
+<uri link="::general-concepts/cvs-to-rsync"/>).
If the upstream download location for a package uses a non-standard TCP port
(anything other than 21, 80 or 443), you <e>must</e> manually mirror the files. Not
diff --git a/general-concepts/use-flags/text.xml b/general-concepts/use-flags/text.xml
index 3904a4c..db8eae6 100644
--- a/general-concepts/use-flags/text.xml
+++ b/general-concepts/use-flags/text.xml
@@ -212,8 +212,9 @@ and it must not be modified in any subprofile.
<p>
The current architecture (e.g. <c>x86</c>, <c>sparc</c>, <c>ppc-macos</c>) will
automatically be set as a USE flag as well. See <c>profiles/arch.list</c> for a
-full list of valid architecture keywords, and `GLEP 22`_ for an explanation of
-the format.
+full list of valid architecture keywords, and
+<uri link="http://www.gentoo.org/proj/en/glep/glep-0022.html">GLEP 22</uri> for
+an explanation of the format.
</p>
<warning>
diff --git a/quickstart/text.xml b/quickstart/text.xml
index e6a004e..d2670a4 100644
--- a/quickstart/text.xml
+++ b/quickstart/text.xml
@@ -13,8 +13,8 @@ idea of how ebuilds work.
</p>
<p>
-For proper coverage of all the ins and outs, see `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>
@@ -76,7 +76,7 @@ At the top of the ebuild is a header block. This is present in all ebuilds.
<p>
Ebuilds are indented using tabs, with each tab representing four places. See
-`Ebuild File Format`_.
+<uri link="::ebuild-writing/file-format"/>.
</p>
</body>
</subsection>
@@ -114,7 +114,8 @@ name and version <d/> in this case, it would be <c>ctags-5.5.4</c>.
<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>&quot;0&quot;</c> or read `Slotting`_.
+you've not seen slots before, either just use <c>&quot;0&quot;</c> or read
+<uri link="::general-concepts/slotting"/>.
</p>
<p>
@@ -145,7 +146,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 `Install Destinations`_ and `Sandbox`_). Again, we check
+this <d/> see <uri link="::general-concepts/install-destinations"/> and
+<uri link="::general-concepts/sandbox"/>). Again, we check
for errors.
</p>
@@ -163,11 +165,12 @@ files into the relevant part of <c>/usr/share/doc</c>.
</p>
<p>
-Ebuilds can define other functions (see `Ebuild Functions`_). In all cases,
-portage provides a reasonable default implementation which quite often does the
-'right thing'. There was no need to define a <c>src_unpack</c> function here, for
-example <d/> this function is used to do any unpacking of tarballs or patching of
-source files, but the default implementation does everything we need.
+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 a <c>src_unpack</c>
+function here, for example <d/> this function is used to do any unpacking of
+tarballs or patching of source files, but the default implementation does
+everything we need.
</p>
</body>
</subsection>
@@ -181,8 +184,9 @@ source files, but the default implementation does everything we need.
<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 `Implicit System Dependency`_ for why we don't need to depend upon
-those explicitly). However, life is rarely that simple.
+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>
<p>
@@ -223,7 +227,8 @@ src_install() {
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 `Predefined Read-Only Variables`_).
+variables <d/> see
+<uri link="::ebuild-writing/variables#Predefined Read-Only Variables"/>).
</p>
<p>
@@ -234,7 +239,7 @@ Again, we define <c>src_compile</c> and <c>src_install</c> functions.
The <c>DEPEND</c> and <c>RDEPEND</c> variables are how portage determines which
packages are needed to build and run the package. The <c>DEPEND</c> variable lists
compile-time dependencies, and the <c>RDEPEND</c> lists runtime dependencies. See
-`Dependencies`_ for some more complex examples.
+<uri link="::general-concepts/dependencies"/> for some more complex examples.
</p>
</body>