svn commit: r43308 - head/en_US.ISO8859-1/books/porters-handbook
Warren Block
wblock at FreeBSD.org
Sun Dec 8 20:39:08 UTC 2013
Author: wblock
Date: Sun Dec 8 20:39:07 2013
New Revision: 43308
URL: http://svnweb.freebsd.org/changeset/doc/43308
Log:
Set all the <package> tags to <package role="port">.
Replace SVN with <application>Subversion</application>.
Rewrite some sentences to avoid "you" and for clarity.
Replace many instances of FreeBSD with &os;.
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 Sun Dec 8 20:03:50 2013 (r43307)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Dec 8 20:39:07 2013 (r43308)
@@ -15,11 +15,11 @@
xml:lang="en">
<info>
- <title>FreeBSD Porter's Handbook</title>
+ <title>&os; Porter's Handbook</title>
<authorgroup>
<author>
- <orgname>The FreeBSD Documentation Project</orgname>
+ <orgname>The &os; Documentation Project</orgname>
</author>
</authorgroup>
@@ -40,7 +40,7 @@
<year>2011</year>
<year>2012</year>
<year>2013</year>
- <holder role="mailto:doc at FreeBSD.org">The FreeBSD Documentation
+ <holder role="mailto:doc at FreeBSD.org">The &os; Documentation
Project</holder>
</copyright>
@@ -59,13 +59,13 @@
<chapter xml:id="why-port">
<title>Introduction</title>
- <para>The FreeBSD ports collection is the way almost everyone
- installs applications ("ports") on FreeBSD. Like everything
- else about FreeBSD, it is primarily a volunteer effort.
+ <para>The &os; Ports Collection is the way almost everyone
+ installs applications ("ports") on &os;. Like everything
+ else about &os;, it is primarily a volunteer effort.
It is important to keep this in mind when reading this
document.</para>
- <para>In FreeBSD, anyone may submit a new port, or volunteer
+ <para>In &os;, anyone may submit a new port, or volunteer
to maintain an existing port if it is unmaintained—you
do not need any special commit privileges to do so.</para>
@@ -78,7 +78,7 @@
upgrading an existing one? Great!</para>
<para>What follows are some guidelines for creating a new port for
- FreeBSD. If you want to upgrade an existing port, you should
+ &os;. If you want to upgrade an existing port, you should
read this and then read <xref linkend="port-upgrading"/>.</para>
<para>When this document is not sufficiently detailed, you should
@@ -124,7 +124,7 @@
<note>
<para>The following assumes that the software compiled
out-of-the-box, i.e., there was absolutely no change required
- for the port to work on your FreeBSD box. If you needed to
+ for the port to work on your &os; box. If you needed to
change something, you will have to refer to the next section
too.</para>
</note>
@@ -168,7 +168,7 @@ COMMENT= Cat chasing a mouse all over th
<para>See if you can figure it out. Do not worry about the
contents of the <literal>$FreeBSD$</literal>
- line, it will be filled in automatically by SVN when the port
+ line, it will be filled in automatically by <application>Subversion</application> 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>
@@ -421,8 +421,8 @@ PLIST_DIRS= lib/X11/oneko</programlistin
the stages.</para>
<para>Thorough automated testing can be done with
- <package>ports-mgmt/tinderbox</package> or
- <package>ports-mgmt/poudriere</package> from the Ports
+ <package role="port">ports-mgmt/tinderbox</package> or
+ <package role="port">ports-mgmt/poudriere</package> from the Ports
Collection. These applications maintain
<literal>jails</literal> where all of the steps shown above
can be tested without affecting the state of the host
@@ -435,7 +435,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<para>Please use <command>portlint</command> to see if your port
conforms to our guidelines. The
- <package>ports-mgmt/portlint</package>
+ <package role="port">ports-mgmt/portlint</package>
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
@@ -503,7 +503,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
if necessary, and put it in the tree. Your name will also
be added to the list of <link
xlink:href="&url.articles.contributors;/contrib-additional.html">Additional
- FreeBSD Contributors</link> and other files.</para>
+ &os; Contributors</link> and other files.</para>
</sect1>
</chapter>
@@ -787,7 +787,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<filename>patch-ab</filename> etc, always mention the path and
file name in patch names.</para>
- <para>Do not put RCS strings in patches. SVN will mangle them
+ <para>Do not put RCS strings in patches. <application>Subversion</application> will mangle them
when we put the files into the ports tree, and when we check
them out again, they will come out different and the patch
will fail. RCS strings are surrounded by dollar
@@ -818,7 +818,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
take a working piece of functionality from one project to fix
similar areas in another, please be careful: the resulting
line patch may be full of non-functional changes. It not only
- increases the size of the SVN repository but makes it hard to
+ increases the size of the <application>Subversion</application> repository but makes it hard to
find out what exactly caused the problem and what you changed
at all.</para>
@@ -1067,7 +1067,7 @@ DOS2UNIX_GLOB= *.c *.cpp *.h</programlis
<sect3>
<title><varname>PORTEPOCH</varname></title>
- <para>From time to time a software vendor or FreeBSD porter
+ <para>From time to time a software vendor or &os; porter
will do something silly and release a version of their
software which is actually numerically less than the
previous version. An example of this is a port which goes
@@ -1122,7 +1122,7 @@ DOS2UNIX_GLOB= *.c *.cpp *.h</programlis
use of <varname>PORTVERSION</varname> can often preempt it
becoming necessary if a future release of the software
should change the version structure. However, care is
- needed by FreeBSD porters when a vendor release is made
+ needed by &os; porters when a vendor release is made
without an official version number — such as a code
<quote>snapshot</quote> release. The temptation is to
label the release with the release date, which will cause
@@ -1152,7 +1152,7 @@ PORTVERSION= 0.10</programlisting>
<literal>gtkmumble-0.10</literal>.</para>
<para>A security hole is discovered which requires a local
- FreeBSD patch. <varname>PORTREVISION</varname> is bumped
+ &os; patch. <varname>PORTREVISION</varname> is bumped
accordingly.</para>
<programlisting>PORTNAME= gtkmumble
@@ -1284,7 +1284,7 @@ PORTEPOCH= 1</programlisting>
<orderedlist>
<listitem>
- <para>FreeBSD strives to support the native language of
+ <para>&os; strives to support the native language of
its users. The <replaceable>language-</replaceable>
part should be a two letter abbreviation of the natural
language defined by ISO-639 if the port is specific to a
@@ -1693,7 +1693,7 @@ PORTEPOCH= 1</programlisting>
<row>
<entry><filename>docs*</filename></entry>
- <entry>Meta-ports for FreeBSD documentation.</entry>
+ <entry>Meta-ports for &os; documentation.</entry>
<entry/>
</row>
@@ -1987,7 +1987,7 @@ PORTEPOCH= 1</programlisting>
<row>
<entry><filename>ports-mgmt</filename></entry>
<entry>Ports for managing, installing and developing
- FreeBSD ports and packages.</entry>
+ &os; ports and packages.</entry>
</row>
<row>
@@ -2803,7 +2803,7 @@ EXTRACT_ONLY= source.tar.gz</programlist
relief to network strain that this would bring.</para>
<para>In the next sections, information will follow on the
- FreeBSD implementation of this idea. We improved a bit on
+ &os; implementation of this idea. We improved a bit on
OpenBSD's concept.</para>
<sect3>
@@ -3613,7 +3613,7 @@ ALWAYS_KEEP_DISTFILES= yes
<para>When URLs listing the available versions differ
from the download URLs. For example, to limit
distfile version checks to the download page for the
- <package>databases/pgtune</package>
+ <package role="port">databases/pgtune</package>
port, add:</para>
<programlisting>PORTSCOUT= site:http://pgfoundry.org/frs/?group_id=1000416</programlisting>
@@ -3735,7 +3735,7 @@ ALWAYS_KEEP_DISTFILES= yes
<filename>ports/Mk/bsd.*.mk</filename> to augment initial
build dependencies. For example,
<literal>USES= gmake</literal> adds
- <package>devel/gmake</package> to
+ <package role="port">devel/gmake</package> to
<varname>BUILD_DEPENDS</varname>. To prevent such
additional dependencies from polluting
<varname>RUN_DEPENDS</varname>, take care to assign with
@@ -4027,7 +4027,7 @@ ALWAYS_KEEP_DISTFILES= yes
<para>The ports building technology does not tolerate circular
dependencies. If you introduce one, you will have someone,
- somewhere in the world, whose FreeBSD installation will
+ somewhere in the world, whose &os; installation will
break almost immediately, with many others quickly to
follow. These can really be hard to detect; if in doubt,
before you make that change, make sure you have done the
@@ -4107,7 +4107,7 @@ LIB_DEPENDS= libbar.so:${PORTSDIR}/foo/b
<para>For more control over dependencies in some cases,
<varname>WANT_</varname> variables are available to more
precisely specify what is needed. For example, consider the
- <package>mail/squirrelmail</package> port.
+ <package role="port">mail/squirrelmail</package> port.
This port needs some PHP modules, which are listed in the
<varname>USE_PHP</varname> variable:</para>
@@ -4159,7 +4159,7 @@ RESOLUTION?= 300
@${FALSE}
.endif</programlisting>
- <para><package>japanese/xdvi300</package> also
+ <para><package role="port">japanese/xdvi300</package> also
has all the regular patches, package files, etc. If you type
<command>make</command> there, it will take the default value
for the resolution (300) and build the port normally.</para>
@@ -4211,7 +4211,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300
uses a different location. However, this is not recommended.
These entries contain just the path relative to
<filename>PREFIX/INFO_PATH</filename>.
- For example, <package>lang/gcc34</package>
+ For example, <package role="port">lang/gcc34</package>
installs info files to
<filename>PREFIX/INFO_PATH/gcc34</filename>,
and <varname>INFO</varname> will be something like
@@ -4296,7 +4296,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300
<row>
<entry><varname>WITH_OPENSSL_PORT</varname></entry>
<entry>Installs the version of OpenSSL from
- <package>security/openssl</package>, even
+ <package role="port">security/openssl</package>, even
if the base is up to date.</entry>
</row>
</tbody>
@@ -5436,10 +5436,10 @@ 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
- <package>lang/moscow_ml</package> for an
+ <package role="port">lang/moscow_ml</package> for an
example), or through a shell-wrapper which sets
<varname>LD_LIBRARY_PATH</varname> before invoking the binary,
- like <package>www/seamonkey</package>
+ like <package role="port">www/seamonkey</package>
does.</para>
<para>When installing 32-bit libraries on 64-bit system, use
@@ -5466,7 +5466,7 @@ PORTVERSION= 1.0</programlisting>
<important>
<para>It is your responsibility as a porter to read the
licensing terms of the software and make sure that the
- FreeBSD project will not be held accountable for violating
+ &os; project will not be held accountable for violating
them by redistributing the source or compiled binaries
either via FTP/HTTP or CD-ROM. If in doubt, please contact
the &a.ports;.</para>
@@ -5810,7 +5810,7 @@ IGNORE= may not be redistributed because
exported to the <varname>PLIST_SUB</varname> and should be
used if port installs <literal>*.cmake</literal> files
depending on the build type (see
- <package>deskutils/strigi</package> for an
+ <package role="port">deskutils/strigi</package> 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
@@ -6099,7 +6099,7 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subp
<para>If your port requires <literal>gettext</literal>, set
<literal>USES= gettext</literal>, and your port will inherit
a dependency on
- <package>devel/gettext</package>. Other
+ <package role="port">devel/gettext</package>. Other
values for <literal>gettext</literal> usage are listed in
<xref linkend="uses-values"/>.</para>
@@ -6189,7 +6189,7 @@ PLIST_SUB+= NLS="@comment "
in
<filename>PORTSDIR/Templates/BSD.local.dist</filename>.
The directories for many other languages are governed by the
- <package>devel/gettext</package> port.
+ <package role="port">devel/gettext</package> port.
Consult its <filename>pkg-plist</filename> and see whether
the port is going to install a message catalog file for a
unique language.</para>
@@ -6445,9 +6445,9 @@ USE_XORG= x11 xpm</programlisting>
<varname>USES= motif</varname> in the
<filename>Makefile</filename>. Default Motif implementation
is
- <package>x11-toolkits/open-motif</package>.
+ <package role="port">x11-toolkits/open-motif</package>.
Users can choose
- <package>x11-toolkits/lesstif</package>
+ <package role="port">x11-toolkits/lesstif</package>
instead by setting <varname>WANT_LESSTIF</varname>
variable.</para>
@@ -6596,11 +6596,11 @@ USE_XORG= x11 xpm</programlisting>
<sect1 xml:id="using-gnome">
<title>Using GNOME</title>
- <para>The FreeBSD/GNOME project uses its own set of variables to
+ <para>The &os;/GNOME project uses its own set of variables to
define which GNOME components a particular port uses. A <link
xlink:href="http://www.FreeBSD.org/gnome/docs/porting.html">comprehensive
list of these variables</link> exists within the
- FreeBSD/GNOME project's homepage.</para>
+ &os;/GNOME project's homepage.</para>
</sect1>
<sect1 xml:id="using-qt">
@@ -6981,7 +6981,7 @@ USE_QT4= qmake_build</programlisting>
Sometimes data such as icons or .desktop files are by
default installed into directories which are not scanned
by XDG-compatible applications.
- <package>editors/texmaker</package> is
+ <package role="port">editors/texmaker</package> is
an example for this - look at
<filename>patch-texmaker.pro</filename> in the
<filename>files</filename> directory of that port for a
@@ -7206,7 +7206,7 @@ USE_QT4= moc_build qmake_build rcc_build
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
- <package>java/openjdk6</package>.</para>
+ <package role="port">java/openjdk6</package>.</para>
<table frame="none">
<title>Variables Which May be Set by Ports That Use
@@ -7564,7 +7564,7 @@ USE_QT4= moc_build qmake_build rcc_build
If you ever think that your port needs more sophisticated
Java support, please first have a look at the <link
xlink:href="http://svnweb.FreeBSD.org/ports/head/Mk/bsd.java.mk?view=markup">bsd.java.mk
- SVN log</link> as it usually takes some time to document
+ <application>Subversion</application> log</link> as it usually takes some time to document
the latest features. Then, if you think the support you are
lacking would be beneficial to many other Java ports, feel
free to discuss it on the &a.java;.</para>
@@ -8216,52 +8216,52 @@ _DOCSDIR= .
<para>The <varname>USE_SDL</varname> variable is used to
autoconfigure the dependencies for ports which use an SDL
- based library like <package>devel/sdl12</package> and
- <package>graphics/sdl_image</package>.</para>
+ based library like <package role="port">devel/sdl12</package> and
+ <package role="port">graphics/sdl_image</package>.</para>
<para>The following SDL libraries for version 1.2 are recognized
at the moment:</para>
<itemizedlist>
<listitem>
- <para>sdl: <package>devel/sdl12</package></para>
+ <para>sdl: <package role="port">devel/sdl12</package></para>
</listitem>
<listitem>
- <para>console: <package>devel/sdl_console</package></para>
+ <para>console: <package role="port">devel/sdl_console</package></para>
</listitem>
<listitem>
- <para>gfx: <package>graphics/sdl_gfx</package></para>
+ <para>gfx: <package role="port">graphics/sdl_gfx</package></para>
</listitem>
<listitem>
- <para>image: <package>graphics/sdl_image</package></para>
+ <para>image: <package role="port">graphics/sdl_image</package></para>
</listitem>
<listitem>
- <para>mixer: <package>audio/sdl_mixer</package></para>
+ <para>mixer: <package role="port">audio/sdl_mixer</package></para>
</listitem>
<listitem>
- <para>mm: <package>devel/sdlmm</package></para>
+ <para>mm: <package role="port">devel/sdlmm</package></para>
</listitem>
<listitem>
- <para>net: <package>net/sdl_net</package></para>
+ <para>net: <package role="port">net/sdl_net</package></para>
</listitem>
<listitem>
<para>pango:
- <package>x11-toolkits/sdl_pango</package></para>
+ <package role="port">x11-toolkits/sdl_pango</package></para>
</listitem>
<listitem>
- <para>sound: <package>audio/sdl_sound</package></para>
+ <para>sound: <package role="port">audio/sdl_sound</package></para>
</listitem>
<listitem>
- <para>ttf: <package>graphics/sdl_ttf</package></para>
+ <para>ttf: <package role="port">graphics/sdl_ttf</package></para>
</listitem>
</itemizedlist>
@@ -8270,41 +8270,41 @@ _DOCSDIR= .
<itemizedlist>
<listitem>
- <para>sdl: <package>devel/sdl20</package></para>
+ <para>sdl: <package role="port">devel/sdl20</package></para>
</listitem>
<listitem>
- <para>gfx: <package>graphics/sdl2_gfx</package></para>
+ <para>gfx: <package role="port">graphics/sdl2_gfx</package></para>
</listitem>
<listitem>
- <para>image: <package>graphics/sdl2_image</package></para>
+ <para>image: <package role="port">graphics/sdl2_image</package></para>
</listitem>
<listitem>
- <para>mixer: <package>audio/sdl2_mixer</package></para>
+ <para>mixer: <package role="port">audio/sdl2_mixer</package></para>
</listitem>
<listitem>
- <para>net: <package>net/sdl2_net</package></para>
+ <para>net: <package role="port">net/sdl2_net</package></para>
</listitem>
<listitem>
- <para>ttf: <package>graphics/sdl2_ttf</package></para>
+ <para>ttf: <package role="port">graphics/sdl2_ttf</package></para>
</listitem>
</itemizedlist>
<para>Therefore, if a port has a dependency on
- <package>net/sdl_net</package> and
- <package>audio/sdl_mixer</package>,
+ <package role="port">net/sdl_net</package> and
+ <package role="port">audio/sdl_mixer</package>,
the syntax will be:</para>
<programlisting>USE_SDL= net mixer</programlisting>
<para>The dependency
- <package>devel/sdl12</package>, which is
- required by <package>net/sdl_net</package>
- and <package>audio/sdl_mixer</package>, is
+ <package role="port">devel/sdl12</package>, which is
+ required by <package role="port">net/sdl_net</package>
+ and <package role="port">audio/sdl_mixer</package>, is
automatically added as well.</para>
<para>If you use <varname>USE_SDL</varname> with entries using
@@ -8448,17 +8448,17 @@ USE_SDL+= mixer
<tbody>
<row>
<entry><literal>2.4</literal></entry>
- <entry><package>x11-toolkits/wxgtk24</package></entry>
+ <entry><package role="port">x11-toolkits/wxgtk24</package></entry>
</row>
<row>
<entry><literal>2.6</literal></entry>
- <entry><package>x11-toolkits/wxgtk26</package></entry>
+ <entry><package role="port">x11-toolkits/wxgtk26</package></entry>
</row>
<row>
<entry><literal>2.8</literal></entry>
- <entry><package>x11-toolkits/wxgtk28</package></entry>
+ <entry><package role="port">x11-toolkits/wxgtk28</package></entry>
</row>
</tbody>
</tgroup>
@@ -9026,17 +9026,17 @@ PLIST_SUB+= VERSION="${VER_STR}"
<tbody>
<row>
<entry><literal>4.0</literal></entry>
- <entry><package>lang/lua4</package></entry>
+ <entry><package role="port">lang/lua4</package></entry>
</row>
<row>
<entry><literal>5.0</literal></entry>
- <entry><package>lang/lua50</package></entry>
+ <entry><package role="port">lang/lua50</package></entry>
</row>
<row>
<entry><literal>5.1</literal></entry>
- <entry><package>lang/lua</package></entry>
+ <entry><package role="port">lang/lua</package></entry>
</row>
</tbody>
</tgroup>
@@ -9495,7 +9495,7 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR
<para>After 2013-10-08 (<revnumber>254273</revnumber>),
&os; 10-CURRENT and newer versions have a native
<command>iconv</command> in the operating system. On earlier
- versions, <package>converters/libiconv</package> was used as a
+ versions, <package role="port">converters/libiconv</package> was used as a
dependency.</para>
<para>For software that needs <command>iconv</command>, define
@@ -9503,7 +9503,7 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR
10-CURRENT on 2013-08-13 (<revnumber>254273</revnumber>) do
not have a native <command>iconv</command>. On these earlier
versions, a dependency on
- <package>converters/libiconv</package> will be added
+ <package role="port">converters/libiconv</package> will be added
automatically.</para>
<para>When a port defines <literal>USES=iconv</literal>, these
@@ -9569,7 +9569,7 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR
<para>These two examples automatically populate the variables
with the correct value for systems using
- <package>converters/libiconv</package> or the
+ <package role="port">converters/libiconv</package> or the
native <command>iconv</command> respectively:</para>
<example xml:id="iconv-simple-use">
@@ -9636,49 +9636,49 @@ post-patch:
<para>The <varname>USE_XFCE</varname> variable is used to
autoconfigure the dependencies for ports which use an Xfce
based library or application like
- <package>x11-toolkits/libxfce4gui</package>
- and <package>x11-wm/xfce4-panel</package>.</para>
+ <package role="port">x11-toolkits/libxfce4gui</package>
+ and <package role="port">x11-wm/xfce4-panel</package>.</para>
<para>The following Xfce libraries and applications are
recognized at the moment:</para>
<itemizedlist>
<listitem>
- <para>libexo: <package>x11/libexo</package></para>
+ <para>libexo: <package role="port">x11/libexo</package></para>
</listitem>
<listitem>
<para>libgui:
- <package>x11-toolkits/libxfce4gui</package></para>
+ <package role="port">x11-toolkits/libxfce4gui</package></para>
</listitem>
<listitem>
- <para>libutil: <package>x11/libxfce4util</package></para>
+ <para>libutil: <package role="port">x11/libxfce4util</package></para>
</listitem>
<listitem>
- <para>libmcs: <package>x11/libxfce4mcs</package></para>
+ <para>libmcs: <package role="port">x11/libxfce4mcs</package></para>
</listitem>
<listitem>
<para>mcsmanager:
- <package>sysutils/xfce4-mcs-manager</package></para>
+ <package role="port">sysutils/xfce4-mcs-manager</package></para>
</listitem>
<listitem>
- <para>panel: <package>x11-wm/xfce4-panel</package></para>
+ <para>panel: <package role="port">x11-wm/xfce4-panel</package></para>
</listitem>
<listitem>
- <para>thunar: <package>x11-fm/thunar</package></para>
+ <para>thunar: <package role="port">x11-fm/thunar</package></para>
</listitem>
<listitem>
- <para>wm: <package>x11-wm/xfce4-wm</package></para>
+ <para>wm: <package role="port">x11-wm/xfce4-wm</package></para>
</listitem>
<listitem>
- <para>xfdev: <package>dev/xfce4-dev-tools</package></para>
+ <para>xfdev: <package role="port">dev/xfce4-dev-tools</package></para>
</listitem>
</itemizedlist>
@@ -9698,7 +9698,7 @@ post-patch:
</itemizedlist>
<para>Therefore, if a port has a dependency on
- <package>sysutils/xfce4-mcs-manager</package>
+ <package role="port">sysutils/xfce4-mcs-manager</package>
and requires the special CPPFLAGS in its configure
environment, the syntax will be:</para>
@@ -9804,7 +9804,7 @@ post-patch:
<entry><varname>USE_BDB</varname></entry>
<entry>If variable is set to <literal>yes</literal>,
add dependency on
- <package>databases/db41</package>
+ <package role="port">databases/db41</package>
port. The variable may also be set to values: 40, 41,
42, 43, 44, 46, 47, 48, or 51. You can declare a
range of acceptable values,
@@ -9817,7 +9817,7 @@ post-patch:
<entry><varname>USE_MYSQL</varname></entry>
<entry>If the variable is set to <literal>yes</literal>, add
a dependency on the
- <package>databases/mysql55-client</package> port. An
+ <package role="port">databases/mysql55-client</package> port. An
associated variable,
<varname>WANT_MYSQL_VER</varname>, may be set to
values such as 323, 40, 41, 50, 51, 52, 55, or
@@ -9827,7 +9827,7 @@ post-patch:
<row>
<entry><varname>USE_PGSQL</varname></entry>
<entry>If set to <literal>yes</literal>, add dependency
- on <package>databases/postgresql90-client</package>
+ on <package role="port">databases/postgresql90-client</package>
port. An associated variable,
<varname>WANT_PGSQL_VER</varname>, may be set to
values such as 83, 84, 90, 91 or 92. You can declare
@@ -9841,7 +9841,7 @@ post-patch:
<entry><varname>USE_SQLITE</varname></entry>
<entry>If variable is set to <literal>yes</literal>, add
dependency on
- <package>databases/sqlite3</package>
+ <package role="port">databases/sqlite3</package>
port. The variable may also be set to values: 3,
2.</entry>
</row>
@@ -10029,7 +10029,7 @@ run_rc_command "$1"</programlisting>
<step>
<para>Make sure there is no
- <literal>KEYWORD: FreeBSD</literal> present. This has
+ <literal>KEYWORD: &os;</literal> present. This has
not been necessary or desirable for years. It is also
an indication that the new script was copy/pasted from
an old script, so extra caution should be given to the
@@ -10717,7 +10717,7 @@ as .putsy.conf and edit it.</programlist
<title>Port Tools</title>
<para>The
- <package>ports-mgmt/porttools</package>
+ <package role="port">ports-mgmt/porttools</package>
program is part of the Ports Collection.</para>
<para><command>port</command> is the front-end script, which can
@@ -10825,7 +10825,7 @@ as .putsy.conf and edit it.</programlist
powerful system for building and testing ports.
You can
install <application>Tinderbox</application> using
- <package>ports-mgmt/tinderbox</package> port.
+ <package role="port">ports-mgmt/tinderbox</package> port.
Be sure to read supplied documentation since the configuration
is not trivial.</para>
@@ -10862,7 +10862,7 @@ as .putsy.conf and edit it.</programlist
<para>However, sometimes people forget to put the name of the port
into the Synopsis field in an unambiguous fashion. In that
case, you can try the
- <link linkend="portsmon">FreeBSD Ports Monitoring System</link>
+ <link linkend="portsmon">&os; Ports Monitoring System</link>
(also known as <literal>portsmon</literal>). This system
attempts to classify port PRs by portname. To search for PRs
about a particular port, use the <link
@@ -10966,15 +10966,15 @@ as .putsy.conf and edit it.</programlist
how to keep up-to-date in <xref linkend="keeping-up"/>.</para>
<sect1 xml:id="svn-diff">
- <title>Using <literal>SVN</literal> to Make Patches</title>
+ <title>Using <application>Subversion</application> to Make Patches</title>
- <para>If you can, please submit a &man.svn.1; diff — they
+ <para>When possible, please submit a &man.svn.1; diff. They
are easier to handle than diffs between
- <quote>new and old</quote> directories. Plus it is easier for
- you to see what you have changed and to update your diff if
- something is modified in the Ports Collection from when you
- started to work on it until you submit your changes, or if the
- committer asks you to fix something.</para>
+ <quote>new and old</quote> directories. It is easier
+ to see what has changed, and to update the diff if
+ something was modified in the Ports Collection since you
+ began work on it, or if the
+ committer asks for something to be fixed.</para>
<screen>&prompt.user; <userinput>cd ~/my_wrkdir</userinput> <co xml:id="my-wrkdir"/>
&prompt.user; <userinput>svn co https://svn0.us-west.FreeBSD.org/ports/head/dns/pdnsd</userinput> <co xml:id="svn-FreeBSD-org"/>
@@ -10991,7 +10991,7 @@ as .putsy.conf and edit it.</programlist
<callout arearefs="svn-FreeBSD-org">
<para><link
xlink:href="https://svn0.us-west.FreeBSD.org/">svn0.us-west.FreeBSD.org</link>
- is a public <literal>SVN</literal> server. Select the
+ is a public <application>Subversion</application> server. Select the
closest mirror and verify the mirror server certificate
from the list of <link
xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
@@ -11016,7 +11016,7 @@ as .putsy.conf and edit it.</programlist
<calloutlist>
<callout arearefs="svn-update">
<para>This will try to merge the differences between your
- patch and current SVN; watch the output carefully. The
+ patch and current repository version; watch the output carefully. The
letter in front of each file name indicates what was done
with it. See <xref linkend="table-svn-up"/> for a
complete list.</para>
@@ -11024,7 +11024,7 @@ as .putsy.conf and edit it.</programlist
</calloutlist>
<table pgwide="1" frame="none" xml:id="table-svn-up">
- <title><literal>SVN</literal> Update File Prefixes</title>
+ <title><application>Subversion</application> Update File Prefixes</title>
<tgroup cols="2">
<tbody>
@@ -11055,17 +11055,17 @@ as .putsy.conf and edit it.</programlist
</tgroup>
</table>
- <para>If you get <literal>C</literal> as a result of
- <command>svn update</command> it means something changed in
- the SVN repository and &man.svn.1; was not able to merge your
- local changes and those from the repository. It is always a
+ <para>If <literal>C</literal> is displayed as a result of
+ <command>svn update</command>, it means something changed in
+ the <application>Subversion</application> repository and &man.svn.1; was not able to merge the
+ local changes with those from the repository. It is always a
good idea to inspect the changes anyway, since &man.svn.1;
does not know anything about how a port should be, so it might
(and probably will) merge things that do not make
sense.</para>
<para>The last step is to make a unified &man.diff.1;
- of the files against SVN:</para>
+ of the changes:</para>
<screen>&prompt.user; <userinput>svn diff > ../`basename ${PWD}`.diff</userinput></screen>
@@ -11243,7 +11243,7 @@ as .putsy.conf and edit it.</programlist
<para>The VuXML database is an <acronym>XML</acronym> document. Its source file
<filename>vuln.xml</filename> is kept right inside the port
- <package>security/vuxml</package>. Therefore the file's
+ <package role="port">security/vuxml</package>. Therefore the file's
full pathname will be
<filename>PORTSDIR/security/vuxml/vuln.xml</filename>. Each
time you discover a security vulnerability in a port, please
@@ -11543,10 +11543,10 @@ as .putsy.conf and edit it.</programlist
<para>As a prerequisite, you need to
<emphasis>install</emphasis> fresh versions of the ports
- <package>ports-mgmt/portaudit</package>,
- <package>ports-mgmt/portaudit-db</package>,
+ <package role="port">ports-mgmt/portaudit</package>,
+ <package role="port">ports-mgmt/portaudit-db</package>,
and
- <package>security/vuxml</package>.</para>
+ <package role="port">security/vuxml</package>.</para>
<note>
<para>To run <command>packaudit</command> you must have
@@ -11587,8 +11587,8 @@ as .putsy.conf and edit it.</programlist
<note>
<para>You will need at least one of the following packages
installed:
- <package>textproc/libxml2</package>,
- <package>textproc/jade</package>.</para>
+ <package role="port">textproc/libxml2</package>,
+ <package role="port">textproc/jade</package>.</para>
</note>
<para>Now rebuild the <command>portaudit</command> database
@@ -11891,7 +11891,7 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
<programlisting>CXX= g++</programlisting>
<para>Both <varname>CC</varname> and <varname>CXX</varname>
- variables can be defined on FreeBSD systems in
+ variables can be defined on &os; systems in
<filename>/etc/make.conf</filename>. The first example
defines a value if it was not previously set in
<filename>/etc/make.conf</filename>, preserving any
@@ -11925,7 +11925,7 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
<programlisting>CFLAGS= -Wall -Werror</programlisting>
<para>The <varname>CFLAGS</varname> variable is defined on
- FreeBSD systems in <filename>/etc/make.conf</filename>. The
+ &os; systems in <filename>/etc/make.conf</filename>. The
first example appends additional flags to the
<varname>CFLAGS</varname> variable, preserving any system-wide
definitions. The second example clobbers anything previously
@@ -12052,7 +12052,7 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
<listitem>
<para><varname>FORBIDDEN</varname> is used for ports that
contain a security vulnerability or induce grave concern
- regarding the security of a FreeBSD system with a given
+ regarding the security of a &os; system with a given
port installed (e.g., a reputably insecure program or a
program that provides easily exploitable services).
Ports should be marked as <varname>FORBIDDEN</varname>
@@ -12060,7 +12060,7 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
vulnerability and there is no released upgrade. Ideally
ports should be upgraded as soon as possible when a
security vulnerability is discovered so as to reduce the
- number of vulnerable FreeBSD hosts (we like being known
+ number of vulnerable &os; hosts (we like being known
for being secure), however sometimes there is a
noticeable time gap between disclosure of a
vulnerability and an updated release of the vulnerable
@@ -12096,8 +12096,8 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD
<listitem>
<para>does not work with some other currently
installed port (for instance, the port depends on
- <package>www/apache20</package> but
- <package>www/apache22</package> is
+ <package role="port">www/apache20</package> but
+ <package role="port">www/apache22</package> is
installed)</para>
</listitem>
</itemizedlist>
@@ -12476,7 +12476,7 @@ pre-install:
change it back again.</para>
<para>FreshPorts also has a sanity test feature which
- automatically tests each commit to the FreeBSD ports tree. If
+ automatically tests each commit to the &os; ports tree. If
subscribed to this service, you will be notified of any errors
which FreshPorts detects during sanity testing of your
commits.</para>
@@ -12568,7 +12568,7 @@ pre-install:
<title>The &os; Ports Monitoring System</title>
<para>Another handy resource is the
- <link xlink:href="http://portsmon.FreeBSD.org">FreeBSD Ports
+ <link xlink:href="http://portsmon.FreeBSD.org">&os; Ports
Monitoring System</link> (also known as
<literal>portsmon</literal>). This system comprises a
database that processes information from several sources and
More information about the svn-doc-head
mailing list