svn commit: r42601 - head/en_US.ISO8859-1/books/porters-handbook
Warren Block
wblock at FreeBSD.org
Thu Aug 29 00:52:21 UTC 2013
Author: wblock
Date: Thu Aug 29 00:52:20 2013
New Revision: 42601
URL: http://svnweb.freebsd.org/changeset/doc/42601
Log:
Whitespace-only fixes. Translators, please ignore.
Modified:
head/en_US.ISO8859-1/books/porters-handbook/book.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/book.xml Wed Aug 28 15:19:37 2013 (r42600)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Thu Aug 29 00:52:20 2013 (r42601)
@@ -88,8 +88,9 @@
tab setting: <application>Emacs</application> and
<application>Vim</application> should recognize the setting on
loading the file. Both &man.vi.1; and &man.ex.1; can be set
- to use the correct value by typing <command>:set
- tabstop=4</command> once the file has been loaded.</para>
+ to use the correct value by typing
+ <command>:set tabstop=4</command> once the file has been
+ loaded.</para>
</note>
<para>
@@ -151,8 +152,8 @@ MANCOMPRESSED= yes
contents of the <literal>$FreeBSD$</literal>
line, it will be filled in automatically by SVN when the port
is imported to our main ports tree. You can find a more
- detailed example in the <link
- linkend="porting-samplem">sample Makefile</link>
+ detailed example in the
+ <link linkend="porting-samplem">sample Makefile</link>
section.</para>
</sect1>
@@ -163,8 +164,8 @@ MANCOMPRESSED= yes
any port, whether they actually package or not. They are
<filename>pkg-descr</filename> and
<filename>pkg-plist</filename>. Their
- <filename>pkg-</filename> prefix distinguishes them from
- other files.</para>
+ <filename>pkg-</filename> prefix distinguishes them from other
+ files.</para>
<sect2>
<title><filename>pkg-descr</filename></title>
@@ -193,13 +194,12 @@ MANCOMPRESSED= yes
runtime environment, or implementation languages help users
decide whether this port will work for them.</para>
- <para>Include a URL to the official WWW homepage.
- Prepend <emphasis>one</emphasis> of
- the websites (pick the most common one) with
- <literal>WWW:</literal> (followed by single space) so that
- automated tools will work correctly. If the URI is the root
- of the website or directory, it should be terminated with a
- slash.</para>
+ <para>Include a URL to the official WWW homepage. Prepend
+ <emphasis>one</emphasis> of the websites (pick the most
+ common one) with <literal>WWW:</literal> (followed by single
+ space) so that automated tools will work correctly. If the
+ URI is the root of the website or directory, it should be
+ terminated with a slash.</para>
<note>
<para>If the listed webpage for a port is not available, try
@@ -397,12 +397,13 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<command>portlint</command></title>
<para>Please use <command>portlint</command> to see if your port
- conforms to our guidelines. The <filename
- role="package">ports-mgmt/portlint</filename> program is
- part of the ports collection. In particular, you may want to
- check if the <link linkend="porting-samplem">Makefile</link>
- is in the right shape and the <link
- linkend="porting-pkgname">package</link> is named
+ conforms to our guidelines. The
+ <filename role="package">ports-mgmt/portlint</filename>
+ program is part of the ports collection. In particular, you
+ may want to check if the
+ <link linkend="porting-samplem">Makefile</link> is in the
+ right shape and the
+ <link linkend="porting-pkgname">package</link> is named
appropriately.</para>
</sect1>
@@ -410,8 +411,8 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<title>Submitting the New Port</title>
<para>Before you submit the new port, make sure you have read
- the <link
- linkend="porting-dads">DOs and DON'Ts</link> section.</para>
+ the <link linkend="porting-dads">DOs and DON'Ts</link>
+ section.</para>
<para>Now that you are happy with your port, the only thing
remaining is to put it in the main &os; ports tree and make
@@ -421,8 +422,8 @@ PLIST_DIRS= lib/X11/oneko</programlistin
Next, assuming your port is called oneko,
<command>cd</command> to the directory above where the
<literal>oneko</literal> directory is located, and then type
- the following: <command>shar `find oneko` >
- oneko.shar</command></para>
+ the following:
+ <command>shar `find oneko` > oneko.shar</command></para>
<para>Include your <literal>oneko.shar</literal> file in a bug
report and send it with the &man.send-pr.1; program (see
@@ -450,9 +451,9 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<para>One more time, <emphasis>do not include the original
source distfile, the <filename>work</filename> directory, or
- the package you built with <command>make
- package</command></emphasis>; and, do use &man.shar.1; for
- new ports, not &man.diff.1;.</para>
+ the package you built with
+ <command>make package</command></emphasis>; and, do use
+ &man.shar.1; for new ports, not &man.diff.1;.</para>
<para>After you have submitted your port, please be patient.
Sometimes it can take a few months before a port is included
@@ -655,19 +656,19 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<makevar>MASTER_SITES</makevar>. If you can, try to talk the
port author out of doing this; it really does help to
establish some kind of source code control. Hosting your own
- version will prevent users from getting <errorname>checksum
- mismatch</errorname> errors, and also reduce the workload of
- maintainers of our FTP site. Also, if there is only one
- master site for the port, it is recommended that you house a
- backup at your site and list it as the second
+ version will prevent users from getting
+ <errorname>checksum mismatch</errorname> errors, and also
+ reduce the workload of maintainers of our FTP site. Also, if
+ there is only one master site for the port, it is recommended
+ that you house a backup at your site and list it as the second
<makevar>MASTER_SITES</makevar>.</para>
<para>If your port requires some additional `patches' that are
available on the Internet, fetch them too and put them in
<makevar>DISTDIR</makevar>. Do not worry if they come from a
site other than where you got the main source tarball, we have
- a way to handle these situations (see the description of <link
- linkend="porting-patchfiles">PATCHFILES</link>
+ a way to handle these situations (see the description of
+ <link linkend="porting-patchfiles">PATCHFILES</link>
below).</para>
</sect1>
@@ -853,8 +854,8 @@ DOS2UNIX_REGEX= .*\.(c|cpp|h)</programli
<para>Configuring the <filename>Makefile</filename> is pretty
simple, and again we suggest that you look at existing examples
- before starting. Also, there is a <link
- linkend="porting-samplem">sample Makefile</link> in this
+ before starting. Also, there is a
+ <link linkend="porting-samplem">sample Makefile</link> in this
handbook, so take a look and please follow the ordering of
variables and sections in that template to make your port easier
for others to read.</para>
@@ -1109,16 +1110,16 @@ PORTREVISION= 1</programlisting>
<para>A new version is released by the vendor, numbered
<literal>0.2</literal> (it turns out the author actually
intended <literal>0.10</literal> to actually mean
- <literal>0.1.0</literal>, not <quote>what comes after
- 0.9</quote> - oops, too late now). Since the new minor
- version <literal>2</literal> is numerically less than the
- previous version <literal>10</literal>, the
- <makevar>PORTEPOCH</makevar> must be bumped to manually
- force the new package to be detected as
- <quote>newer</quote>. Since it is a new vendor release of
- the code, <makevar>PORTREVISION</makevar> is reset to 0
- (or removed from the
- <filename>Makefile</filename>).</para>
+ <literal>0.1.0</literal>, not
+ <quote>what comes after 0.9</quote> - oops, too late now).
+ Since the new minor version <literal>2</literal> is
+ numerically less than the previous version
+ <literal>10</literal>, the <makevar>PORTEPOCH</makevar>
+ must be bumped to manually force the new package to be
+ detected as <quote>newer</quote>. Since it is a new
+ vendor release of the code,
+ <makevar>PORTREVISION</makevar> is reset to 0 (or removed
+ from the <filename>Makefile</filename>).</para>
<programlisting>PORTNAME= gtkmumble
PORTVERSION= 0.2
@@ -1162,9 +1163,9 @@ PORTEPOCH= 1</programlisting>
<makevar>PORTVERSION</makevar> to form
<makevar>PKGNAME</makevar> as
<literal>${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}</literal>.
- Make sure this conforms to our <link
- linkend="porting-pkgname">guidelines for a good package
- name</link>. In particular, you are
+ Make sure this conforms to our
+ <link linkend="porting-pkgname">guidelines for a good
+ package name</link>. In particular, you are
<emphasis>not</emphasis> allowed to use a hyphen
(<literal>-</literal>) in <makevar>PORTVERSION</makevar>.
Also, if the package name has the
@@ -1202,8 +1203,8 @@ PORTEPOCH= 1</programlisting>
use. By setting <makevar>NO_LATEST_LINK</makevar>, no link
will be generated, which may be an option for all but the
<quote>main</quote> version. Note that how to choose a
- <quote>main</quote> version — <quote>most
- popular</quote>, <quote>best supported</quote>,
+ <quote>main</quote> version —
+ <quote>most popular</quote>, <quote>best supported</quote>,
<quote>least patched</quote>, and so on — is outside
the scope of this handbook's recommendations; we only tell
you how to specify the other ports' versions after you have
@@ -1499,8 +1500,8 @@ PORTEPOCH= 1</programlisting>
<para>This list also determines where in the ports tree the
port is imported. If you put more than one category here,
it is assumed that the port files will be put in the
- subdirectory with the name in the first category. See <link
- linkend="choosing-categories">below</link> for more
+ subdirectory with the name in the first category. See
+ <link linkend="choosing-categories">below</link> for more
discussion about how to pick the right categories.</para>
</sect2>
@@ -1706,8 +1707,8 @@ PORTEPOCH= 1</programlisting>
<row>
<entry><filename>gnome*</filename></entry>
- <entry>Ports from the <ulink
- url="http://www.gnome.org">GNOME</ulink>
+ <entry>Ports from the
+ <ulink url="http://www.gnome.org">GNOME</ulink>
Project.</entry>
<entry></entry>
</row>
@@ -1781,8 +1782,8 @@ PORTEPOCH= 1</programlisting>
<row>
<entry><filename>kde*</filename></entry>
- <entry>Ports from the <ulink
- url="http://www.kde.org">KDE</ulink>
+ <entry>Ports from the
+ <ulink url="http://www.kde.org">KDE</ulink>
Project.</entry>
<entry></entry>
</row>
@@ -2119,9 +2120,9 @@ PORTEPOCH= 1</programlisting>
<row>
<entry><filename>xfce*</filename></entry>
- <entry>Ports related to the <ulink
- url="http://www.xfce.org/">Xfce</ulink> desktop
- environment.</entry>
+ <entry>Ports related to the
+ <ulink url="http://www.xfce.org/">Xfce</ulink>
+ desktop environment.</entry>
<entry></entry>
</row>
@@ -2485,6 +2486,7 @@ MASTER_SITE_SUBDIR= make</programlisting
<programlisting>MASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
<para>This can be also written as</para>
+
<programlisting>MASTER_SITES= SF
MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
@@ -2691,9 +2693,9 @@ EXTRACT_ONLY= source.tar.gz</programlist
Sites and Subdirectories
(<literal>MASTER_SITES:n</literal>)</title>
- <para>(Consider this to be a somewhat <quote>advanced
- topic</quote>; those new to this document may wish to skip
- this section at first).</para>
+ <para>(Consider this to be a somewhat
+ <quote>advanced topic</quote>; those new to this document
+ may wish to skip this section at first).</para>
<para>This section has information on the fetching mechanism
known as both <literal>MASTER_SITES:n</literal> and
@@ -3522,8 +3524,8 @@ ALWAYS_KEEP_DISTFILES= yes
checks because it is known to be broken, add:</para>
<programlisting>PORTSCOUT= ignore:8.2</programlisting>
-
</listitem>
+
<listitem>
<para>When specific versions or specific major and minor
revisions of a distfile should be checked. For
@@ -3533,8 +3535,8 @@ ALWAYS_KEEP_DISTFILES= yes
&os;, add:</para>
<programlisting>PORTSCOUT= limit:^0\.6\.4</programlisting>
-
</listitem>
+
<listitem>
<para>When URLs listing the available versions differ
from the download URLs. For example, to limit
@@ -3574,10 +3576,9 @@ ALWAYS_KEEP_DISTFILES= yes
<programlisting>LIB_DEPENDS= libjpeg.so:${PORTSDIR}/graphics/jpeg</programlisting>
<para>will check for a shared jpeg library with any version,
- and descend into the
- <filename>graphics/jpeg</filename> subdirectory of your
- ports tree to build and install it if it is not found.
- </para>
+ and descend into the <filename>graphics/jpeg</filename>
+ subdirectory of your ports tree to build and install it if
+ it is not found.</para>
<para>The dependency is checked twice, once from within the
<maketarget>extract</maketarget> target and then from within
@@ -3661,8 +3662,8 @@ ALWAYS_KEEP_DISTFILES= yes
variables, which are processed by
<filename>ports/Mk/bsd.*.mk</filename> to augment initial
build dependencies. For example,
- <literal>USES= gmake</literal> adds <filename
- role="package">devel/gmake</filename> to
+ <literal>USES= gmake</literal> adds
+ <filename role="package">devel/gmake</filename> to
<makevar>BUILD_DEPENDS</makevar>. To prevent such
additional dependencies from polluting
<makevar>RUN_DEPENDS</makevar>, take care to assign with
@@ -4111,9 +4112,9 @@ MASTERDIR= ${.CURDIR}/../xdvi300
automatically add any manpages to
<filename>pkg-plist</filename> (this means you must
<emphasis>not</emphasis> list manpages in the
- <filename>pkg-plist</filename>—see <link
- linkend="plist-sub">generating PLIST</link> for more). It
- also makes the install stage automatically compress or
+ <filename>pkg-plist</filename>—see
+ <link linkend="plist-sub">generating PLIST</link> for more).
+ It also makes the install stage automatically compress or
uncompress manpages depending on the setting of
<makevar>NO_MANCOMPRESS</makevar> in
<filename>/etc/make.conf</filename>.</para>
@@ -4518,7 +4519,6 @@ CONFIGURE_ARGS+= --without-examples
.include <bsd.port.mk></programlisting>
</example>
-
</sect3>
<sect3>
@@ -4604,15 +4604,17 @@ CONFIGURE_ARGS+= --disable-foo
<note>
<para>Under some circumstances, the shorthand conditional
- syntax can cause problems with complex constructs.
- If you receive errors such as <literal>Malformed
- conditional</literal>, an alternative syntax can be
- used.</para>
+ syntax can cause problems with complex constructs. If you
+ receive errors such as
+ <literal>Malformed conditional</literal>, an alternative
+ syntax can be used.</para>
+
<programlisting>.if !empty(VARIABLE:MVALUE)
# as an alternative to
.if ${VARIABLE:MVALUE}</programlisting>
</note>
</sect2>
+
<sect2>
<title>Options Helpers</title>
@@ -4620,8 +4622,8 @@ CONFIGURE_ARGS+= --disable-foo
values which differ based on the options set.</para>
<para>If <makevar>OPTIONS_SUB</makevar> is set to
- <literal>yes</literal> then each of the options added
- to <makevar>OPTIONS_DEFINE</makevar> will be added to
+ <literal>yes</literal> then each of the options added
+ to <makevar>OPTIONS_DEFINE</makevar> will be added to
<makevar>PLIST_SUB</makevar>, for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
@@ -4640,10 +4642,10 @@ PLIST_SUB+= OPT1="@comment "
.endif</programlisting>
<para>If <makevar>X_CONFIGURE_ENABLE</makevar> is set then
- <literal>--enable-${X_CONFIGURE_ENABLE}</literal>
- or <literal>--disable-${X_CONFIGURE_ENABLE}</literal> will
- be added to <makevar>CONFIGURE_ARGS</makevar> depending on
- the value of the option<makevar>X</makevar>, for example:</para>
+ <literal>--enable-${X_CONFIGURE_ENABLE}</literal> or
+ <literal>--disable-${X_CONFIGURE_ENABLE}</literal> will be
+ added to <makevar>CONFIGURE_ARGS</makevar> depending on the
+ value of the option<makevar>X</makevar>, for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
OPT1_CONFIGURE_ENABLE= test</programlisting>
@@ -4663,7 +4665,7 @@ CONFIGURE_ARGS+= --disable-test
<para>If <makevar>X_CONFIGURE_WITH</makevar> is set then
<literal>--with-${X_CONFIGURE_WITH}</literal>
or <literal>--without-${X_CONFIGURE_WITH}</literal> will
- be added to <makevar>CONFIGURE_ARGS</makevar> depending
+ be added to <makevar>CONFIGURE_ARGS</makevar> depending
on the status of the option <makevar>X</makevar>,
for example:</para>
@@ -4682,10 +4684,10 @@ CONFIGURE_ARGS+= --with-test
CONFIGURE_ARGS+= --without-test
.endif</programlisting>
- <para>If <makevar>X_CONFIGURE_ON</makevar> is set then its value
- will be appended to <makevar>CONFIGURE_ARGS</makevar> depending
- on the status of the option <makevar>X</makevar>, for example:
- </para>
+ <para>If <makevar>X_CONFIGURE_ON</makevar> is set then its
+ value will be appended to <makevar>CONFIGURE_ARGS</makevar>
+ depending on the status of the option <makevar>X</makevar>,
+ for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
OPT1_CONFIGURE_ON= --add-test</programlisting>
@@ -4700,10 +4702,10 @@ OPT1_CONFIGURE_ON= --add-test</programli
CONFIGURE_ARGS+= --add-test
.endif</programlisting>
- <para>If <makevar>X_CONFIGURE_OFF</makevar> is set then its value
- will be appended to <makevar>CONFIGURE_ARGS</makevar> depending
- on the status of the option <makevar>X</makevar>, for example:
- </para>
+ <para>If <makevar>X_CONFIGURE_OFF</makevar> is set then its
+ value will be appended to <makevar>CONFIGURE_ARGS</makevar>
+ depending on the status of the option <makevar>X</makevar>,
+ for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
OPT1_CONFIGURE_OFF= --no-test</programlisting>
@@ -4718,8 +4720,8 @@ CONFIGURE_ARGS+= --no-test
<para>If <makevar>X_CMAKE_ON</makevar> is set then its value
will be appended to <makevar>CMAKE_ARGS</makevar> depending
- on the status of the option <makevar>X</makevar>, for example:
- </para>
+ on the status of the option <makevar>X</makevar>, for
+ example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
OPT1_CMAKE_ON= -DTEST:BOOL=true</programlisting>
@@ -4736,8 +4738,8 @@ CMAKE_ARGS+= -DTEST:BOOL=true
<para>If <makevar>X_CMAKE_OFF</makevar> is set then its value
will be appended to <makevar>CMAKE_ARGS</makevar> depending
- on the status of the option <makevar>X</makevar>, for example:
- </para>
+ on the status of the option <makevar>X</makevar>, for
+ example:</para>
<programlisting>OPTIONS_DEFINE= OPT1
OPT1_CMAKE_OFF= -DTEST:BOOL=false</programlisting>
@@ -4755,33 +4757,33 @@ CMAKE_ARGS+= -DTEST:BOOL=false
<para>For any of the following variables:</para>
<itemizedlist>
- <listitem>
- <para><makevar>CFLAGS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>CFLAGS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>CXXFLAGS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>CXXFLAGS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>LDLAGS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>LDLAGS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>CONFIGURE_ENV</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>CONFIGURE_ENV</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>MAKE_ENV</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>MAKE_ENV</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>USES</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>USES</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>DISTFILES</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>DISTFILES</makevar></para>
+ </listitem>
</itemizedlist>
<para>If <makevar>X_ABOVEVARIABLE</makevar> is defined then
@@ -4807,33 +4809,33 @@ CFLAGS+= -DTEST
<para>For any of the following dependency type:</para>
<itemizedlist>
- <listitem>
- <para><makevar>PKG_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>PKG_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>EXTRACT_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>EXTRACT_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>PATCH_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>PATCH_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>FETCH_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>FETCH_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>BUILD_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>BUILD_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>LIB_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>LIB_DEPENDS</makevar></para>
+ </listitem>
- <listitem>
- <para><makevar>RUN_DEPENDS</makevar></para>
- </listitem>
+ <listitem>
+ <para><makevar>RUN_DEPENDS</makevar></para>
+ </listitem>
</itemizedlist>
<para>If <makevar>X_ABOVEVARIABLE</makevar> is defined then
@@ -5188,8 +5190,8 @@ PORTVERSION= 1.0</programlisting>
<filename>share/doc/<makevar>PORTNAME</makevar></filename>
will be substituted for <literal>%%DOCSDIR%%</literal> in
the packing list by default, and so on. (See more on
- <filename>pkg-plist</filename> substitution <link
- linkend="plist-sub">here</link>.)</para>
+ <filename>pkg-plist</filename> substitution
+ <link linkend="plist-sub">here</link>.)</para>
<para>All conditionally installed documentation files and
directories should be included in
@@ -5229,8 +5231,8 @@ PORTVERSION= 1.0</programlisting>
<makevar>PORTEXAMPLES</makevar>, respectively.</para>
<para>You can also use the <filename>pkg-message</filename>
- file to display messages upon installation. See <link
- linkend="porting-message">the section on using
+ file to display messages upon installation. See
+ <link linkend="porting-message">the section on using
<filename>pkg-message</filename></link> for details. The
<filename>pkg-message</filename> file does not need to be
added to <filename>pkg-plist</filename>.</para>
@@ -5304,9 +5306,9 @@ PORTVERSION= 1.0</programlisting>
<para>Please double-check, often this is not necessary at all or
can be avoided through <literal>-rpath</literal> or setting
- <envar>LD_RUN_PATH</envar> during linking (see <filename
- role="package">lang/moscow_ml</filename> for an example), or
- through a shell-wrapper which sets
+ <envar>LD_RUN_PATH</envar> during linking (see
+ <filename role="package">lang/moscow_ml</filename> for an
+ example), or through a shell-wrapper which sets
<makevar>LD_LIBRARY_PATH</makevar> before invoking the binary,
like <filename role="package">www/seamonkey</filename>
does.</para>
@@ -5530,12 +5532,13 @@ IGNORE= may not be redistributed because
<filename>Imakefile</filename> files using
<application>imake</application>, then set
<literal>USES= imake</literal>. This will cause the
- configure stage to automatically do an <command>xmkmf
- -a</command>. If the <option>-a</option> flag is a
- problem for your port, set <literal>XMKMF=xmkmf</literal>.
- If the port uses <application>imake</application> but does
- not understand the <maketarget>install.man</maketarget>
- target, <literal>NO_INSTALL_MANPAGES=yes</literal> should be
+ configure stage to automatically do an
+ <command>xmkmf -a</command>. If the <option>-a</option>
+ flag is a problem for your port, set
+ <literal>XMKMF=xmkmf</literal>. If the port uses
+ <application>imake</application> but does not understand the
+ <maketarget>install.man</maketarget> target,
+ <literal>NO_INSTALL_MANPAGES=yes</literal> should be
set.</para>
<para>If your port's source <filename>Makefile</filename> has
@@ -5676,8 +5679,8 @@ IGNORE= may not be redistributed because
lower-cased value of <makevar>CMAKE_BUILD_TYPE</makevar> is
exported to the <makevar>PLIST_SUB</makevar> and should be
used if port installs <literal>*.cmake</literal> files
- depending on the build type (see <filename
- role="package">deskutils/strigi</filename> for an
+ depending on the build type (see
+ <filename role="package">deskutils/strigi</filename> for an
example). Please note that some projects may define their
own build profiles and/or force particular build type by
setting <literal>CMAKE_BUILD_TYPE</literal> in
@@ -5999,9 +6002,9 @@ GNU_CONFIGURE= yes</programlisting>
through passing <option>--disable-nls</option> to
<command>configure</command>. In that case, your port
should use <literal>gettext</literal> conditionally,
- depending on the status of the <makevar>NLS</makevar> option.
- For ports of low to medium complexity, you can rely on the
- following idiom:</para>
+ depending on the status of the <makevar>NLS</makevar>
+ option. For ports of low to medium complexity, you can rely
+ on the following idiom:</para>
<programlisting>GNU_CONFIGURE= yes
@@ -6052,7 +6055,6 @@ PLIST_SUB+= NLS="@comment "
reside under
<filename><makevar>LOCALBASE</makevar>/share/locale</filename>,
should rarely be created and removed by a port. The most
-
popular languages have their respective directories listed
in
<filename><makevar>PORTSDIR</makevar>/Templates/BSD.local.dist</filename>.
@@ -6253,9 +6255,10 @@ PLIST_SUB+= NLS="@comment "
<para>The Mesa Project is an effort to provide free OpenGL
implementation. You can specify a dependency on various
components of this project with <makevar>USE_GL</makevar>
- variable. Valid options are: <literal>glut, glu, glw, glew,
- gl</literal> and <literal>linux</literal>. For backwards
- compatibility, the value of <literal>yes</literal> maps to
+ variable. Valid options are:
+ <literal>glut, glu, glw, glew, gl</literal> and
+ <literal>linux</literal>. For backwards compatibility, the
+ value of <literal>yes</literal> maps to
<literal>glu</literal>.</para>
<example id="use-xorg-example">
@@ -6299,11 +6302,12 @@ USE_XORG= x11 xpm</programlisting>
<para>If your port requires a Motif library, define
<makevar>USES= motif</makevar> in the
<filename>Makefile</filename>. Default Motif implementation
- is <filename
- role="package">x11-toolkits/open-motif</filename>. Users
- can choose <filename
- role="package">x11-toolkits/lesstif</filename> instead by
- setting <makevar>WANT_LESSTIF</makevar> variable.</para>
+ is
+ <filename role="package">x11-toolkits/open-motif</filename>.
+ Users can choose
+ <filename role="package">x11-toolkits/lesstif</filename>
+ instead by setting <makevar>WANT_LESSTIF</makevar>
+ variable.</para>
<para>The <makevar>MOTIFLIB</makevar> variable will be set by
<filename>bsd.port.mk</filename> to reference the
@@ -6399,9 +6403,10 @@ USE_XORG= x11 xpm</programlisting>
<para>If a port has a MimeType entry in its
<filename><replaceable>portname</replaceable>.desktop</filename>,
- the desktop database must
- be updated after install and deinstall. To do this,
- define <makevar>USES</makevar>= desktop-file-utils.</para>
+ the desktop database must be updated after install and
+ deinstall. To do this, define <makevar>USES</makevar>=
+ desktop-file-utils.</para>
+
</sect3>
<sect3 id="desktop-entries-macro">
@@ -6480,8 +6485,8 @@ USE_XORG= x11 xpm</programlisting>
<row>
<entry><makevar>USE_QT4</makevar></entry>
<entry>Specify tool and library dependencies for ports
- that use Qt 4. See <link
- linkend="qt4-components">Qt 4 component
+ that use Qt 4. See
+ <link linkend="qt4-components">Qt 4 component
selection</link> for more details.</entry>
</row>
@@ -6609,20 +6614,20 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE
<sect2 id="qt4-components">
<title>Component Selection (Qt 4.x Only)</title>
- <para>Individual Qt 4 tool and library dependencies
- must be specified in the <makevar>USE_QT4</makevar>
- variable. Every component
- can be suffixed by either <literal>_build</literal> or
- <literal>_run</literal>, the suffix indicating whether the
- component should be depended on at buildtime or runtime,
- respectively. If unsuffixed, the component will be depended
- on at both build- and runtime. Usually, library components
- should be specified unsuffixed, tool components should be
- specified with the <literal>_build</literal> suffix and
- plugin components should be specified with the
- <literal>_run</literal> suffix. The most commonly used
- components are listed below (all available components are
- listed in <makevar>_USE_QT4_ALL</makevar> in
+ <para>Individual Qt 4 tool and library dependencies must be
+ specified in the <makevar>USE_QT4</makevar> variable. Every
+ component can be suffixed by either
+ <literal>_build</literal> or <literal>_run</literal>, the
+ suffix indicating whether the component should be depended
+ on at buildtime or runtime, respectively. If unsuffixed,
+ the component will be depended on at both build- and
+ runtime. Usually, library components should be specified
+ unsuffixed, tool components should be specified with the
+ <literal>_build</literal> suffix and plugin components
+ should be specified with the <literal>_run</literal> suffix.
+ The most commonly used components are listed below (all
+ available components are listed in
+ <makevar>_USE_QT4_ALL</makevar> in
<filename>/usr/ports/Mk/bsd.qt.mk</filename>):</para>
<table frame="none">
@@ -6682,7 +6687,6 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE
<entry><literal>xml</literal></entry>
<entry>XML library</entry>
</row>
-
</tbody>
</tgroup>
</table>
@@ -6755,7 +6759,6 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE
<entry>imageformat plugins for GIF, JPEG, MNG and
SVG (if the application ships image files)</entry>
</row>
-
</tbody>
</tgroup>
</table>
@@ -6825,9 +6828,9 @@ do-configure:
<para><emphasis>Bogus installation paths.</emphasis>
Sometimes data such as icons or .desktop files are by
default installed into directories which are not scanned
- by XDG-compatible applications. <filename
- role="package">editors/texmaker</filename> is an
- example for this - look at
+ by XDG-compatible applications.
+ <filename role="package">editors/texmaker</filename> is
+ an example for this - look at
<filename>patch-texmaker.pro</filename> in the
<filename>files</filename> directory of that port for a
template on how to remedy this directly in the
@@ -7003,13 +7006,13 @@ do-configure:
<para>KDE 4.x ports are installed into
<makevar>KDE4_PREFIX</makevar>, which is
- <filename>/usr/local/kde4</filename> currently.
- This is achieved by
- specifying the <literal>kdeprefix</literal> component, which
- overrides the default <makevar>PREFIX</makevar>. The ports
- however respect any <makevar>PREFIX</makevar> set via
- <envar>MAKEFLAGS</envar> environment variable and/or
- <command>make</command> arguments.</para>
+ <filename>/usr/local/kde4</filename> currently. This is
+ achieved by specifying the <literal>kdeprefix</literal>
+ component, which overrides the default
+ <makevar>PREFIX</makevar>. The ports however respect any
+ <makevar>PREFIX</makevar> set via <envar>MAKEFLAGS</envar>
+ environment variable and/or <command>make</command>
+ arguments.</para>
<example id="kde4-components-example">
<title><makevar>USE_KDE4</makevar> Example</title>
@@ -7050,8 +7053,8 @@ USE_QT4= moc_build qmake_build rcc_build
<para>There are several JDKs in the ports collection, from
various vendors, and in several versions. If your port must
use one of these versions, you can define which one. The
- most current version, and &os; default is <filename
- role="package">java/openjdk6</filename>.</para>
+ most current version, and &os; default is
+ <filename role="package">java/openjdk6</filename>.</para>
<table frame="none">
<title>Variables Which May be Set by Ports That Use
@@ -7064,6 +7067,7 @@ USE_QT4= moc_build qmake_build rcc_build
<entry>Means</entry>
</row>
</thead>
+
<tbody>
<row>
<entry><makevar>USE_JAVA</makevar></entry>
@@ -7132,6 +7136,7 @@ USE_QT4= moc_build qmake_build rcc_build
<entry>Value</entry>
</row>
</thead>
+
<tbody>
<row>
<entry><makevar>JAVA_PORT</makevar></entry>
@@ -7149,7 +7154,6 @@ USE_QT4= moc_build qmake_build rcc_build
<row>
<entry><makevar>JAVA_PORT_OS</makevar></entry>
-
<entry>The operating system used by the JDK port
(e.g., <literal>'native'</literal>).</entry>
</row>
@@ -7297,6 +7301,7 @@ USE_QT4= moc_build qmake_build rcc_build
<entry>Value</entry>
</row>
</thead>
+
<tbody>
<row>
<entry><makevar>JAVASHAREDIR</makevar></entry>
@@ -7338,8 +7343,8 @@ USE_QT4= moc_build qmake_build rcc_build
default one will be set that simply runs Ant according to
<makevar>MAKE_ENV</makevar>, <makevar>MAKE_ARGS</makevar>
and <makevar>ALL_TARGET</makevar>. This is similar to the
- <makevar>USES= gmake</makevar> mechanism, which is documented
- in <xref linkend="building"/>.</para>
+ <makevar>USES= gmake</makevar> mechanism, which is
+ documented in <xref linkend="building"/>.</para>
</sect2>
<sect2 id="java-best-practices">
@@ -7370,14 +7375,14 @@ USE_QT4= moc_build qmake_build rcc_build
<para>Regardless of the type of your port (library or
application), the additional documentation should be
- installed in the <link linkend="install-documentation">same
- location</link> as for any other port. The JavaDoc tool is
- known to produce a different set of files depending on the
- version of the JDK that is used. For ports that do not
- enforce the use of a particular JDK, it is therefore a
- complex task to specify the packing list
- (<filename>pkg-plist</filename>). This is one reason why
- porters are strongly encouraged to use the
+ installed in the
+ <link linkend="install-documentation">same location</link>
+ as for any other port. The JavaDoc tool is known to produce
+ a different set of files depending on the version of the JDK
+ that is used. For ports that do not enforce the use of a
+ particular JDK, it is therefore a complex task to specify
+ the packing list (<filename>pkg-plist</filename>). This is
+ one reason why porters are strongly encouraged to use the
<makevar>PORTDOCS</makevar> macro. Moreover, even if you
can predict the set of files that will be generated by
<command>javadoc</command>, the size of the resulting
@@ -7389,18 +7394,18 @@ USE_QT4= moc_build qmake_build rcc_build
good idea to override <makevar>DATADIR</makevar> to
<filename>${JAVASHAREDIR}/${PORTNAME}</filename> for Java
ports. Indeed, <makevar>DATADIR</makevar> is automatically
- added to <makevar>PLIST_SUB</makevar> (documented in <xref
- linkend="plist-sub"/>) so you may use
+ added to <makevar>PLIST_SUB</makevar> (documented in
+ <xref linkend="plist-sub"/>) so you may use
<literal>%%DATADIR%%</literal> directly in
<filename>pkg-plist</filename>.</para>
<para>As for the choice of building Java ports from source or
directly installing them from a binary distribution, there
is no defined policy at the time of writing. However,
- people from the <ulink
- url="http://www.freebsd.org/java/">&os; Java
- Project</ulink> encourage porters to have their ports built
- from source whenever it is a trivial task.</para>
+ people from the
+ <ulink url="http://www.freebsd.org/java/">&os; Java
+ Project</ulink> encourage porters to have their ports
+ built from source whenever it is a trivial task.</para>
<para>All the features that have been presented in this
section are implemented in <filename>bsd.java.mk</filename>.
@@ -7568,9 +7573,9 @@ USE_QT4= moc_build qmake_build rcc_build
as <makevar>WWWOWN</makevar> and <makevar>WWWGRP</makevar>,
in case you need to change the ownership of some files. The
default values of both are <literal>www</literal>. If you
- want different values for your port, use <literal>WWWOWN?=
- myuser</literal> notation, to allow user to override it
- easily.</para>
+ want different values for your port, use
+ <literal>WWWOWN?= myuser</literal> notation, to allow user
+ to override it easily.</para>
<para>Do not depend on Apache unless the web app explicitly
needs Apache. Respect that users may wish to run your web
@@ -7590,8 +7595,8 @@ USE_QT4= moc_build qmake_build rcc_build
<entry>The port requires PHP. The value
<literal>yes</literal> adds a dependency on PHP.
The list of required PHP extensions can be specified
- instead. Example: <literal>pcre xml
- gettext</literal></entry>
+ instead. Example:
+ <literal>pcre xml gettext</literal></entry>
</row>
<row>
@@ -7808,8 +7813,8 @@ _DOCSDIR= .
<entry><makevar>USE_TWISTED</makevar></entry>
<entry>Add dependency on twistedCore. The list of
required components can be specified as a value of
- this variable. Example: <literal>web lore pair
- flow</literal></entry>
+ this variable. Example:
+ <literal>web lore pair flow</literal></entry>
</row>
<row>
@@ -7968,7 +7973,6 @@ _DOCSDIR= .
<filename>setup.rb</filename>. Common value is
<filename>install.rb</filename>.</entry>
</row>
-
</tbody>
</tgroup>
</table>
@@ -8034,7 +8038,6 @@ _DOCSDIR= .
<entry>Module examples installation path.</entry>
<entry><literal>/usr/local/share/examples/ruby18/patsy</literal></entry>
</row>
-
</tbody>
</tgroup>
</table>
@@ -8049,8 +8052,8 @@ _DOCSDIR= .
<para>The <makevar>USE_SDL</makevar> variable is used to
autoconfigure the dependencies for ports which use an SDL
- based library like <filename
- role="package">devel/sdl12</filename> and <filename
+ based library like
+ <filename role="package">devel/sdl12</filename> and <filename
role="package">x11-toolkits/sdl_gui</filename>.</para>
<para>The following SDL libraries are recognized at the
@@ -8115,11 +8118,11 @@ _DOCSDIR= .
<programlisting>USE_SDL= net mixer</programlisting>
- <para>The dependency <filename
- role="package">devel/sdl12</filename>, which is required by
- <filename role="package">net/sdl_net</filename> and <filename
- role="package">audio/sdl_mixer</filename>, is automatically
- added as well.</para>
+ <para>The dependency
+ <filename role="package">devel/sdl12</filename>, which is
+ required by <filename role="package">net/sdl_net</filename>
+ and <filename role="package">audio/sdl_mixer</filename>, is
+ automatically added as well.</para>
<para>If you use <makevar>USE_SDL</makevar>, it will
automatically:</para>
@@ -8400,9 +8403,9 @@ USE_SDL+= mixer
<para>The dependency type can be selected for each component
by adding a suffix separated by a semicolon. If not present
- then a default type will be used (see <xref
- linkend="wx-def-dep-types"/>). The following types are
- available:</para>
+ then a default type will be used (see
+ <xref linkend="wx-def-dep-types"/>). The following types
+ are available:</para>
<table frame="none">
<title>Available <application>wxWidgets</application>
@@ -8979,9 +8982,9 @@ WANT_LUA_VER= 5.0</programlisting>
<para>The dependency type can be selected for each component
by adding a suffix separated by a semicolon. If not present
- then a default type will be used (see <xref
- linkend="lua-def-dep-types"/>). The following types are
- available:</para>
+ then a default type will be used (see
+ <xref linkend="lua-def-dep-types"/>). The following types
+ are available:</para>
<table frame="none">
<title>Available <application>Lua</application> Dependency
@@ -9117,8 +9120,8 @@ CONFIGURE_ARGS+= --enable-tolua
<title>Defined Variables</title>
<para>The following variables are available in the port (after
- defining one from <xref
- linkend="lua-ver-sel-table"/>).</para>
+ defining one from
+ <xref linkend="lua-ver-sel-table"/>).</para>
<table frame="none">
<title>Variables Defined for Ports That Use
@@ -9293,9 +9296,10 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR
*** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
More information about the svn-doc-all
mailing list