svn commit: r44305 - in head/en_US.ISO8859-1/books/porters-handbook: makefiles quick-porting slow-porting special
Mathieu Arnold
mat at FreeBSD.org
Fri Mar 21 13:26:42 UTC 2014
Author: mat (ports committer)
Date: Fri Mar 21 13:26:41 2014
New Revision: 44305
URL: http://svnweb.freebsd.org/changeset/doc/44305
Log:
Add xml:id to sect[123].
Sponsored by: Absolight
Modified:
head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml
head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Thu Mar 20 19:37:47 2014 (r44304)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Mar 21 13:26:41 2014 (r44305)
@@ -49,7 +49,7 @@
names the port, describes its version number, and lists it in
the correct category.</para>
- <sect2>
+ <sect2 xml:id="makefile-portname">
<title><varname>PORTNAME</varname> and
<varname>PORTVERSION</varname></title>
@@ -70,7 +70,7 @@
<title><varname>PORTREVISION</varname> and
<varname>PORTEPOCH</varname></title>
- <sect3>
+ <sect3 xml:id="makefile-portrevision">
<title><varname>PORTREVISION</varname></title>
<para>The <varname>PORTREVISION</varname> variable is a
@@ -176,7 +176,7 @@
<varname>PORTREVISION</varname> should be bumped.</para>
</sect3>
- <sect3>
+ <sect3 xml:id="makefile-portepoch">
<title><varname>PORTEPOCH</varname></title>
<para>From time to time a software vendor or &os; porter will
@@ -241,7 +241,7 @@
still a numerically greater value.</para>
</sect3>
- <sect3>
+ <sect3 xml:id="makefile-portrevision-example">
<title>Example of <varname>PORTREVISION</varname> and
<varname>PORTEPOCH</varname> Usage</title>
@@ -602,7 +602,7 @@ PORTEPOCH= 1</programlisting>
<sect1 xml:id="makefile-categories">
<title>Categorization</title>
- <sect2>
+ <sect2 xml:id="makefile-categories-definition">
<title><varname>CATEGORIES</varname></title>
<para>When a package is created, it is put under
@@ -1480,7 +1480,7 @@ PORTEPOCH= 1</programlisting>
describes the files that must be downloaded in order to build
the port, and where they can be downloaded from.</para>
- <sect2>
+ <sect2 xml:id="makefile-distversion">
<title><varname>DISTVERSION/DISTNAME</varname></title>
<para><varname>DISTNAME</varname> is the name of the port as
@@ -1570,7 +1570,7 @@ PORTEPOCH= 1</programlisting>
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-master_sites">
<title><varname>MASTER_SITES</varname></title>
<para>Record the directory part of the FTP/HTTP-URL pointing at
@@ -1734,7 +1734,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealP
</table>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-extract_sufx">
<title><varname>EXTRACT_SUFX</varname></title>
<para>If you have one distribution file, and it uses an odd
@@ -1764,7 +1764,7 @@ EXTRACT_SUFX= .tar.gzip</programlisting>
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-distfiles-definition">
<title><varname>DISTFILES</varname></title>
<para>Sometimes the names of the files to be downloaded have no
@@ -1784,7 +1784,7 @@ EXTRACT_SUFX= .tar.gzip</programlisting>
<literal>${DISTNAME}${EXTRACT_SUFX}</literal>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-extract_only">
<title><varname>EXTRACT_ONLY</varname></title>
<para>If only some of the <varname>DISTFILES</varname> must be
@@ -1903,7 +1903,7 @@ EXTRACT_ONLY= source.tar.gz</programlist
&os; implementation of this idea. We improved a bit on
OpenBSD's concept.</para>
- <sect3>
+ <sect3 xml:id="porting-master-sites-n-simplified">
<title>Simplified Information</title>
<para>This section tells you how to quickly prepare fine
@@ -1972,7 +1972,7 @@ DISTFILES= source1.tar.gz:source1 \
</example>
</sect3>
- <sect3>
+ <sect3 xml:id="ports-master-sites-n-detailed">
<title>Detailed Information</title>
<para>Okay, so the previous section example did not reflect
@@ -2373,7 +2373,7 @@ PATCHFILES= patch1:test</programlisting>
</orderedlist>
</sect3>
- <sect3>
+ <sect3 xml:id="port-master-sites-n-what-changed">
<title>What Does Change for Ports? What Does Not?</title>
<orderedlist numeration="lowerroman">
@@ -2494,7 +2494,7 @@ PATCHFILES= patch1:test</programlisting>
</sect3>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-dist_subdir">
<title><varname>DIST_SUBDIR</varname></title>
<para>Do not let your port clutter
@@ -2525,7 +2525,7 @@ PATCHFILES= patch1:test</programlisting>
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-always_keep_distfiles">
<title><varname>ALWAYS_KEEP_DISTFILES</varname></title>
<para>If your port uses binary distfiles and has a license that
@@ -2716,7 +2716,7 @@ ALWAYS_KEEP_DISTFILES= yes
also some pre-supported dependency variables for common cases,
plus a few more to control the behavior of dependencies.</para>
- <sect2>
+ <sect2 xml:id="makefile-lib_depends">
<title><varname>LIB_DEPENDS</varname></title>
<para>This variable specifies the shared libraries this port
@@ -2743,7 +2743,7 @@ ALWAYS_KEEP_DISTFILES= yes
system.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-run_depends">
<title><varname>RUN_DEPENDS</varname></title>
<para>This variable specifies executables or files this port
@@ -2824,7 +2824,7 @@ ALWAYS_KEEP_DISTFILES= yes
<programlisting>RUN_DEPENDS:= ${BUILD_DEPENDS}</programlisting>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-build_depends">
<title><varname>BUILD_DEPENDS</varname></title>
<para>This variable specifies executables or files this port
@@ -2849,7 +2849,7 @@ ALWAYS_KEEP_DISTFILES= yes
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-fetch_depends">
<title><varname>FETCH_DEPENDS</varname></title>
<para>This variable specifies executables or files this port
@@ -2870,7 +2870,7 @@ ALWAYS_KEEP_DISTFILES= yes
the same as <varname>DEPENDS_TARGET</varname>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-extract_depends">
<title><varname>EXTRACT_DEPENDS</varname></title>
<para>This variable specifies executables or files this port
@@ -2900,7 +2900,7 @@ ALWAYS_KEEP_DISTFILES= yes
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-patch_depends">
<title><varname>PATCH_DEPENDS</varname></title>
<para>This variable specifies executables or files this port
@@ -3029,7 +3029,7 @@ ALWAYS_KEEP_DISTFILES= yes
<application>Xfce</application>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-version-dependency">
<title>Minimal Version of a Dependency</title>
<para>A minimal version of a dependency can be specified in any
@@ -3045,7 +3045,7 @@ ALWAYS_KEEP_DISTFILES= yes
p5-Spiffy-0.26 or newer is installed on the machine.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-note-on-dependencies">
<title>Notes on Dependencies</title>
<para>As mentioned above, the default target to call when a
@@ -3080,7 +3080,7 @@ ALWAYS_KEEP_DISTFILES= yes
and extract it.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-circular-dependencies">
<title>Circular Dependencies Are Fatal</title>
<important>
@@ -3100,7 +3100,7 @@ ALWAYS_KEEP_DISTFILES= yes
a lot of grief in the process.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-automatic-dependencies">
<title>Problems Caused by Automatic Dependencies</title>
<para>Dependencies must be declared either explicitly or by
@@ -3293,10 +3293,10 @@ MASTERDIR= ${.CURDIR}/../xdvi300
options properly will make users happy, and effectively provide
two or more ports for the price of one.</para>
- <sect2>
+ <sect2 xml:id="makefile-knobs">
<title>Knobs</title>
- <sect3>
+ <sect3 xml:id="makefile-knobs-with_">
<title><varname>WITH_<replaceable>*</replaceable></varname>
and
<varname>WITHOUT_<replaceable>*</replaceable></varname></title>
@@ -3360,7 +3360,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300
</table>
</sect3>
- <sect3>
+ <sect3 xml:id="makefile-knobs-naming">
<title>Knob Naming</title>
<para>Porters should use like-named knobs, both for the
@@ -3382,10 +3382,10 @@ MASTERDIR= ${.CURDIR}/../xdvi300
</sect3>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-options-options">
<title><varname>OPTIONS</varname></title>
- <sect3>
+ <sect3 xml:id="makefile-options-background">
<title>Background</title>
<para>The <varname>OPTIONS_*</varname> variables give the
@@ -3415,7 +3415,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300
to remove the saved configuration.</para>
</sect3>
- <sect3>
+ <sect3 xml:id="makefile-options-syntax">
<title>Syntax</title>
<para><varname>OPTIONS_DEFINE</varname> contains a list of
@@ -3574,7 +3574,7 @@ EXAMPLES_CONFIGURE_WITH= examples
</example>
</sect3>
- <sect3>
+ <sect3 xml:id="makefile-options-default">
<title>Default Options</title>
<para>The following options are always on by default.</para>
@@ -3610,7 +3610,7 @@ EXAMPLES_CONFIGURE_WITH= examples
</sect3>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-options-auto-activation">
<title>Feature Auto-Activation</title>
<para>When using a GNU configure script, keep an eye on which
@@ -3660,13 +3660,13 @@ FOO_CONFIGURE_ENABLE= foo</programlistin
</note>
</sect2>
- <sect2>
+ <sect2 xml:id="options-helpers">
<title>Options Helpers</title>
<para>There are some macros to help simplify conditional values
which differ based on the options set.</para>
- <sect3>
+ <sect3 xml:id="options_sub">
<title>OPTIONS_SUB</title>
<para>If <varname>OPTIONS_SUB</varname> is set to
@@ -3690,7 +3690,7 @@ PLIST_SUB+= OPT1="@comment " NO_OPT1=""
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-configure_enable">
<title>X_CONFIGURE_ENABLE</title>
<para>If <varname>X_CONFIGURE_ENABLE</varname> is set then
@@ -3715,7 +3715,7 @@ CONFIGURE_ARGS+= --disable-test
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-configure_with">
<title>X_CONFIGURE_WITH</title>
<para>If <varname>X_CONFIGURE_WITH</varname> is set then
@@ -3741,7 +3741,7 @@ CONFIGURE_ARGS+= --without-test
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-configure_on">
<title>X_CONFIGURE_ON</title>
<para>If <varname>X_CONFIGURE_ON</varname> is set then its
@@ -3763,7 +3763,7 @@ CONFIGURE_ARGS+= --add-test
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-configure_off">
<title>X_CONFIGURE_OFF</title>
<para>If <varname>X_CONFIGURE_OFF</varname> is set then its
@@ -3785,7 +3785,7 @@ CONFIGURE_ARGS+= --no-test
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-cmake_on">
<title>X_CMAKE_ON</title>
<para>If <varname>X_CMAKE_ON</varname> is set then its value
@@ -3807,7 +3807,7 @@ CMAKE_ARGS+= -DTEST:BOOL=true
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-cmake_off">
<title>X_CMAKE_OFF</title>
<para>If <varname>X_CMAKE_OFF</varname> is set then its value
@@ -3829,7 +3829,7 @@ CMAKE_ARGS+= -DTEST:BOOL=false
.endif</programlisting>
</sect3>
- <sect3>
+ <sect3 xml:id="options-dependencies">
<title>Dependencies</title>
<para>For any of the following dependency type:</para>
@@ -3910,7 +3910,7 @@ LIB_DEPENDS+= liba.so:${PORTSDIR}/devel/
</sect4>
</sect3>
- <sect3>
+ <sect3 xml:id="options-variables">
<title>Generic Variables Replacement</title>
<para>For any of the following variables:</para>
@@ -4070,7 +4070,7 @@ PORTVERSION= 1.0</programlisting>
<para>There are a number of variables you can override if that is
not the case.</para>
- <sect2>
+ <sect2 xml:id="makefile-wrksrc">
<title><varname>WRKSRC</varname></title>
<para>The variable lists the name of the directory that is
@@ -4086,7 +4086,7 @@ PORTVERSION= 1.0</programlisting>
<programlisting>WRKSRC= ${WRKDIR}/${PORTNAME}</programlisting>
</sect2>
- <sect2>
+ <sect2 xml:id="makefile-no_wrksubdir">
<title><varname>NO_WRKSUBDIR</varname></title>
<para>If the port does not extract in to a subdirectory at all
@@ -4116,7 +4116,7 @@ PORTVERSION= 1.0</programlisting>
those other ports for a few months to cater for users who only
update once in a while.</para>
- <sect2>
+ <sect2 xml:id="conflicts-conflicts_install">
<title><varname>CONFLICTS_INSTALL</varname></title>
<para>If your package cannot coexist with other packages
@@ -4133,7 +4133,7 @@ PORTVERSION= 1.0</programlisting>
stage and prior to the install stage.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="conflicts-conflicts_build">
<title><varname>CONFLICTS_BUILD</varname></title>
<para>If your port cannot be built if a certain port is already
@@ -4146,7 +4146,7 @@ PORTVERSION= 1.0</programlisting>
conflicts are not recorded in the resulting package.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="conflicts-conflicts">
<title><varname>CONFLICTS</varname></title>
<para>If your port cannot be built if a certain port is already
Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Thu Mar 20 19:37:47 2014 (r44304)
+++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Fri Mar 21 13:26:41 2014 (r44305)
@@ -84,7 +84,7 @@ COMMENT= Cat chasing a mouse all over th
<filename>pkg-</filename> prefix distinguishes them from other
files.</para>
- <sect2>
+ <sect2 xml:id="porting-pkg-descr">
<title><filename>pkg-descr</filename></title>
<para>This is a longer description of the port. One to a few
@@ -135,7 +135,7 @@ the screen.
WWW: http://www.oneko.org/</programlisting>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-pkg-plist">
<title><filename>pkg-plist</filename></title>
<para>This file lists all the files installed by the port. It
Modified: head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Thu Mar 20 19:37:47 2014 (r44304)
+++ head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Fri Mar 21 13:26:41 2014 (r44305)
@@ -264,7 +264,7 @@
<screen>&prompt.user; <userinput>cp <replaceable>file</replaceable> <replaceable>file</replaceable>.orig</userinput></screen>
- <sect2>
+ <sect2 xml:id="slow-patch-automatic">
<title>Automatic Patch Generation</title>
<para>When all the files have been modified, use <command>make
@@ -274,7 +274,7 @@
</sect2>
- <sect2>
+ <sect2 xml:id="slow-patch-manual">
<title>Manual Patch Generation</title>
<para>Patches are saved into files named
@@ -348,7 +348,7 @@
</sect2>
- <sect2>
+ <sect2 xml:id="slow-patch-rules">
<title>General Rules for Patching</title>
<para>Try to minimize the amount of non-functional whitespace
@@ -368,7 +368,7 @@
</sect2>
- <sect2>
+ <sect2 xml:id="slow-patch-automatic-replacements">
<title>Simple Automatic Replacements</title>
<para>Simple replacements can be performed directly from the
Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Thu Mar 20 19:37:47 2014 (r44304)
+++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Mar 21 13:26:41 2014 (r44305)
@@ -167,7 +167,7 @@
<para>In situations like this, the variables described in the
following sections can be set.</para>
- <sect2>
+ <sect2 xml:id="porting-restrictions-no_package">
<title><varname>NO_PACKAGE</varname></title>
<para>This variable indicates that we may not generate a
@@ -193,7 +193,7 @@
generated.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-no_cdrom">
<title><varname>NO_CDROM</varname></title>
<para>This variable alone indicates that, although we are
@@ -215,7 +215,7 @@
only.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-nofetchfiles">
<title><varname>NOFETCHFILES</varname></title>
<para>Files defined in the <varname>NOFETCHFILES</varname>
@@ -228,7 +228,7 @@
files and not report about them.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-restricted">
<title><varname>RESTRICTED</varname></title>
<para>Set this variable alone if the application's license
@@ -250,7 +250,7 @@
<acronym>EULA</acronym>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-restricted_files">
<title><varname>RESTRICTED_FILES</varname></title>
<para>When <varname>RESTRICTED</varname> or
@@ -261,7 +261,7 @@
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-legal_text">
<title><varname>LEGAL_TEXT</varname></title>
<para>If the port has legal concerns not addressed by the
@@ -272,7 +272,7 @@
so.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-legal">
<title><filename>/usr/ports/LEGAL</filename> and
<varname>LEGAL</varname></title>
@@ -284,7 +284,7 @@
<command>make -VLEGAL</command>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="porting-restrictions-examples">
<title>Examples</title>
<para>The preferred way to state "the distfiles for this port
@@ -785,7 +785,7 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subp
<sect1 xml:id="using-gettext">
<title>Using GNU <literal>gettext</literal></title>
- <sect2>
+ <sect2 xml:id="using-gettext-basic">
<title>Basic Usage</title>
<para>If your port requires <literal>gettext</literal>, set
@@ -816,7 +816,7 @@ LDFLAGS+= -L${LOCALBASE}/lib
GNU_CONFIGURE= yes</programlisting>
</sect2>
- <sect2>
+ <sect2 xml:id="using-gettext-optional">
<title>Optional Usage</title>
<para>Some software products allow for disabling NLS, e.g.,
@@ -882,7 +882,7 @@ PLIST_SUB+= NLS="@comment "
generation</link>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="using-gettext-catalog-directories">
<title>Handling Message Catalog Directories</title>
<para>There is a point to note about installing message
@@ -1156,7 +1156,7 @@ USE_XORG= x11 xpm</programlisting>
in front.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="x11-fonts">
<title>X11 Fonts</title>
<para>If your port installs fonts for the X Window System, put
@@ -1164,7 +1164,7 @@ USE_XORG= x11 xpm</programlisting>
<filename>LOCALBASE/lib/X11/fonts/local</filename>.</para>
</sect2>
- <sect2>
+ <sect2 xml:id="x11-fake-display">
<title>Getting a Fake <envar>DISPLAY</envar> with Xvfb</title>
<para>Some applications require a working X11 display for
@@ -1198,7 +1198,7 @@ USE_XORG= x11 xpm</programlisting>
encouraged for applications which can be used in a desktop
environment.</para>
- <sect3>
+ <sect3 xml:id="desktop-entries-predefined">
<title>Using Predefined <filename>.desktop</filename>
Files</title>
@@ -2280,7 +2280,7 @@ do-install:
<para>Similarly, there is a defined policy regarding the
<varname>CATEGORIES</varname> of a Java port, which is
- detailed in <xref linkend="makefile-categories"/>.</para>
+ detailed in <xref linkend="makefile-categorization"/>.</para>
</sect2>
</sect1>
@@ -2517,7 +2517,7 @@ do-install:
</table>
</sect2>
- <sect2>
+ <sect2 xml:id="php-pear">
<title>PEAR Modules</title>
<para>Porting PEAR modules is a very simple process.</para>
@@ -4655,7 +4655,7 @@ run_rc_command "$1"</programlisting>
<literal>_enable</literal> variable is not optional,
and should use the ":" for the default.</para>
- <sect2>
+ <sect2 xml:id="rc-scripts-checklist">
<title>Pre-Commit Checklist</title>
<para>Before contributing a port with an
More information about the svn-doc-head
mailing list