os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Whitespace-only cleanup, translators please ignore.

Browse source
This commit is contained in:
Warren Block 2014-01-12 20:30:37 +00:00
parent 24a1a087c7
commit 0f2f83dda5
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=43482
1 changed files with 165 additions and 128 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

293
en_US.ISO8859-1/books/porters-handbook/book.xml
View file

@ -168,9 +168,10 @@ COMMENT= Cat chasing a mouse all over the screen
<para>See if you can figure it out. Do not worry about the <para>See if you can figure it out. Do not worry about the
contents of the <literal>&dollar;FreeBSD&dollar;</literal> contents of the <literal>&dollar;FreeBSD&dollar;</literal>
line, it will be filled in automatically by <application>Subversion</application> when the port line, it will be filled in automatically by
is imported to our main ports tree. You can find a more <application>Subversion</application> when the port is
detailed example in the imported to our main ports tree. You can find a more detailed
example in the
<link linkend="porting-samplem">sample Makefile</link> <link linkend="porting-samplem">sample Makefile</link>
section.</para> section.</para>
</sect1> </sect1>
@ -422,8 +423,8 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<para>Thorough automated testing can be done with <para>Thorough automated testing can be done with
<package role="port">ports-mgmt/tinderbox</package> or <package role="port">ports-mgmt/tinderbox</package> or
<package role="port">ports-mgmt/poudriere</package> from the Ports <package role="port">ports-mgmt/poudriere</package> from the
Collection. These applications maintain Ports Collection. These applications maintain
<literal>jails</literal> where all of the steps shown above <literal>jails</literal> where all of the steps shown above
can be tested without affecting the state of the host can be tested without affecting the state of the host
system.</para> system.</para>
@ -451,14 +452,17 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
the <link linkend="porting-dads">DOs and DON'Ts</link> the <link linkend="porting-dads">DOs and DON'Ts</link>
section.</para> section.</para>
<para>Once happy with your port, the only thing <para>Once happy with your port, the only thing remaining is to
remaining is to put it in the main &os; ports tree and make put it in the main &os; ports tree and make everybody else
everybody else happy about it too. We do not need the happy about it too. We do not need the
<filename>work</filename> directory or the <filename>work</filename> directory or the
<filename>pkgname.tgz</filename> package, so delete them now.</para> <filename>pkgname.tgz</filename> package, so delete them
<para>Next, build the &man.shar.1; file. Assuming the port is called <literal>oneko</literal>, now.</para>
<command>cd</command> to the directory above where the
<literal>oneko</literal> directory is located, and then type: <para>Next, build the &man.shar.1; file. Assuming the port is
called <literal>oneko</literal>, <command>cd</command> to the
directory above where the <literal>oneko</literal> directory
is located, and then type:
<command>shar `find oneko` &gt; oneko.shar</command></para> <command>shar `find oneko` &gt; oneko.shar</command></para>
<para>Include <filename>oneko.shar</filename> in a bug <para>Include <filename>oneko.shar</filename> in a bug
@ -467,23 +471,24 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
xlink:href="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug xlink:href="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug
Reports and General Commentary</link> for more information Reports and General Commentary</link> for more information
about &man.send-pr.1;.</para> about &man.send-pr.1;.</para>
<para>Classify the bug report
as Category <literal>ports</literal> and Class <para>Classify the bug report as Category
<literal>change-request</literal>. Do <emphasis>not</emphasis> mark the report <literal>ports</literal> and Class
<literal>confidential</literal>! Add a short <literal>change-request</literal>. Do
description of the program to the <emphasis>not</emphasis> mark the report
Description field of the PR (perhaps a <literal>confidential</literal>! Add a short description of
short version of the <varname>COMMENT</varname>), and add the program to the Description field of the PR (perhaps a
the <filename>.shar</filename> file to the Fix field.</para> short version of the <varname>COMMENT</varname>), and add the
<filename>.shar</filename> file to the Fix field.</para>
<note> <note>
<para>Giving a good <para>Giving a good description in the synopsis of the problem
description in the synopsis of the problem report makes the work of port committers a lot easier. We report makes the work of port committers a lot easier. We
prefer something like <quote>New port: prefer something like <quote>New port:
&lt;category&gt;/&lt;portname&gt; &lt;short description of &lt;category&gt;/&lt;portname&gt; &lt;short description of
the port&gt;</quote> for new ports. Using this the port&gt;</quote> for new ports. Using this
scheme makes it easier and faster to begin the work of committing scheme makes it easier and faster to begin the work of
the new port.</para> committing the new port.</para>
</note> </note>
<para>One more time, <emphasis>do not include the original <para>One more time, <emphasis>do not include the original
@ -492,15 +497,15 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<command>make package</command></emphasis>; and, do use <command>make package</command></emphasis>; and, do use
&man.shar.1; for new ports, not &man.diff.1;.</para> &man.shar.1; for new ports, not &man.diff.1;.</para>
<para>After submitting the port, please be patient. The time needed <para>After submitting the port, please be patient. The time
to include a new port in &os; can vary from a few days to a needed to include a new port in &os; can vary from a few days
a few months. The list to a a few months. The list of pending port
of pending port <acronym>PR</acronym>s can be viewed at <link <acronym>PR</acronym>s can be viewed at <link
xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports"></link>.</para> xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports"></link>.</para>
<para>After looking at the new port, we will reply <para>After looking at the new port, we will reply if necessary,
if necessary, and put it in the tree. Your name will also and put it in the tree. Your name will also be added to the
be added to the list of <link list of <link
xlink:href="&url.articles.contributors;/contrib-additional.html">Additional xlink:href="&url.articles.contributors;/contrib-additional.html">Additional
&os; Contributors</link> and other files.</para> &os; Contributors</link> and other files.</para>
</sect1> </sect1>
@ -786,10 +791,11 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<filename>patch-ab</filename> etc, always mention the path and <filename>patch-ab</filename> etc, always mention the path and
file name in patch names.</para> file name in patch names.</para>
<para>Do not put RCS strings in patches. <application>Subversion</application> will mangle them <para>Do not put RCS strings in patches.
when we put the files into the ports tree, and when we check <application>Subversion</application> will mangle them when we
them out again, they will come out different and the patch put the files into the ports tree, and when we check them out
will fail. RCS strings are surrounded by dollar again, they will come out different and the patch will fail.
RCS strings are surrounded by dollar
(<literal>&dollar;</literal>) signs, and typically start with (<literal>&dollar;</literal>) signs, and typically start with
<literal>&dollar;Id</literal> or <literal>&dollar;Id</literal> or
<literal>&dollar;RCS</literal>.</para> <literal>&dollar;RCS</literal>.</para>
@ -817,9 +823,10 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
take a working piece of functionality from one project to fix take a working piece of functionality from one project to fix
similar areas in another, please be careful: the resulting similar areas in another, please be careful: the resulting
line patch may be full of non-functional changes. It not only line patch may be full of non-functional changes. It not only
increases the size of the <application>Subversion</application> repository but makes it hard to increases the size of the
find out what exactly caused the problem and what you changed <application>Subversion</application> repository but makes it
at all.</para> hard to find out what exactly caused the problem and what you
changed at all.</para>
<para>If you had to delete a file, then you can do it in the <para>If you had to delete a file, then you can do it in the
<buildtarget>post-extract</buildtarget> target rather than as <buildtarget>post-extract</buildtarget> target rather than as
@ -4295,8 +4302,8 @@ MASTERDIR= ${.CURDIR}/../xdvi300
<row> <row>
<entry><varname>WITH_OPENSSL_PORT</varname></entry> <entry><varname>WITH_OPENSSL_PORT</varname></entry>
<entry>Installs the version of OpenSSL from <entry>Installs the version of OpenSSL from
<package role="port">security/openssl</package>, even <package role="port">security/openssl</package>,
if the base is up to date.</entry> even if the base is up to date.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
@ -5624,12 +5631,13 @@ IGNORE= may not be redistributed because of licensing reasons. Please visit <rep
<para>This is achieved by passing <varname>-jX</varname> flag <para>This is achieved by passing <varname>-jX</varname> flag
to &man.make.1; running on vendor code. This is the default to &man.make.1; running on vendor code. This is the default
build behavior of ports. Unfortunately, not all ports handle build behavior of ports. Unfortunately, not all ports
parallel building well and it may be required to explicitly handle parallel building well and it may be required to
disable this feature by adding the explicitly disable this feature by adding the
<literal>MAKE_JOBS_UNSAFE=yes</literal> variable. It is used <literal>MAKE_JOBS_UNSAFE=yes</literal> variable. It is
when a port is known to be broken with used when a port is known to be broken with
<varname>-jX</varname>.</para> <varname>-jX</varname>.</para>
</sect2> </sect2>
<sect2 xml:id="using-make"> <sect2 xml:id="using-make">
@ -7575,10 +7583,11 @@ USE_QT4= moc_build qmake_build rcc_build uic_build</programlisting>
If you ever think that your port needs more sophisticated If you ever think that your port needs more sophisticated
Java support, please first have a look at the <link 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 xlink:href="http://svnweb.FreeBSD.org/ports/head/Mk/bsd.java.mk?view=markup">bsd.java.mk
<application>Subversion</application> log</link> as it usually takes some time to document <application>Subversion</application> log</link> as it
the latest features. Then, if you think the support you are usually takes some time to document the latest features.
lacking would be beneficial to many other Java ports, feel Then, if you think the support you are lacking would be
free to discuss it on the &a.java;.</para> beneficial to many other Java ports, feel free to discuss it
on the &a.java;.</para>
<para>Although there is a <literal>java</literal> category for <para>Although there is a <literal>java</literal> category for
PRs, it refers to the JDK porting effort from the &os; Java PRs, it refers to the JDK porting effort from the &os; Java
@ -8227,8 +8236,8 @@ _DOCSDIR= .
<para>The <varname>USE_SDL</varname> variable is used to <para>The <varname>USE_SDL</varname> variable is used to
autoconfigure the dependencies for ports which use an SDL autoconfigure the dependencies for ports which use an SDL
based library like <package role="port">devel/sdl12</package> and based library like <package role="port">devel/sdl12</package>
<package role="port">graphics/sdl_image</package>.</para> and <package role="port">graphics/sdl_image</package>.</para>
<para>The following SDL libraries for version 1.2 are recognized <para>The following SDL libraries for version 1.2 are recognized
at the moment:</para> at the moment:</para>
@ -8239,19 +8248,23 @@ _DOCSDIR= .
</listitem> </listitem>
<listitem> <listitem>
<para>console: <package role="port">devel/sdl_console</package></para> <para>console: <package
role="port">devel/sdl_console</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>gfx: <package role="port">graphics/sdl_gfx</package></para> <para>gfx: <package
role="port">graphics/sdl_gfx</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>image: <package role="port">graphics/sdl_image</package></para> <para>image: <package
role="port">graphics/sdl_image</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>mixer: <package role="port">audio/sdl_mixer</package></para> <para>mixer: <package
role="port">audio/sdl_mixer</package></para>
</listitem> </listitem>
<listitem> <listitem>
@ -8263,16 +8276,18 @@ _DOCSDIR= .
</listitem> </listitem>
<listitem> <listitem>
<para>pango: <para>pango: <package
<package role="port">x11-toolkits/sdl_pango</package></para> role="port">x11-toolkits/sdl_pango</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>sound: <package role="port">audio/sdl_sound</package></para> <para>sound: <package
role="port">audio/sdl_sound</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>ttf: <package role="port">graphics/sdl_ttf</package></para> <para>ttf: <package
role="port">graphics/sdl_ttf</package></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -8285,23 +8300,28 @@ _DOCSDIR= .
</listitem> </listitem>
<listitem> <listitem>
<para>gfx: <package role="port">graphics/sdl2_gfx</package></para> <para>gfx: <package
role="port">graphics/sdl2_gfx</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>image: <package role="port">graphics/sdl2_image</package></para> <para>image: <package
role="port">graphics/sdl2_image</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>mixer: <package role="port">audio/sdl2_mixer</package></para> <para>mixer: <package
role="port">audio/sdl2_mixer</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>net: <package role="port">net/sdl2_net</package></para> <para>net: <package
role="port">net/sdl2_net</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>ttf: <package role="port">graphics/sdl2_ttf</package></para> <para>ttf: <package
role="port">graphics/sdl2_ttf</package></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -8459,17 +8479,20 @@ USE_SDL+= mixer
<tbody> <tbody>
<row> <row>
<entry><literal>2.4</literal></entry> <entry><literal>2.4</literal></entry>
<entry><package role="port">x11-toolkits/wxgtk24</package></entry> <entry><package
role="port">x11-toolkits/wxgtk24</package></entry>
</row> </row>
<row> <row>
<entry><literal>2.6</literal></entry> <entry><literal>2.6</literal></entry>
<entry><package role="port">x11-toolkits/wxgtk26</package></entry> <entry><package
role="port">x11-toolkits/wxgtk26</package></entry>
</row> </row>
<row> <row>
<entry><literal>2.8</literal></entry> <entry><literal>2.8</literal></entry>
<entry><package role="port">x11-toolkits/wxgtk28</package></entry> <entry><package
role="port">x11-toolkits/wxgtk28</package></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
@ -9037,12 +9060,14 @@ PLIST_SUB+= VERSION="${VER_STR}"
<tbody> <tbody>
<row> <row>
<entry><literal>4.0</literal></entry> <entry><literal>4.0</literal></entry>
<entry><package role="port">lang/lua4</package></entry> <entry><package
role="port">lang/lua4</package></entry>
</row> </row>
<row> <row>
<entry><literal>5.0</literal></entry> <entry><literal>5.0</literal></entry>
<entry><package role="port">lang/lua50</package></entry> <entry><package
role="port">lang/lua50</package></entry>
</row> </row>
<row> <row>
@ -9506,16 +9531,16 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}"
<para>After 2013-10-08 (<revnumber>254273</revnumber>), <para>After 2013-10-08 (<revnumber>254273</revnumber>),
&os;&nbsp; 10-CURRENT and newer versions have a native &os;&nbsp; 10-CURRENT and newer versions have a native
<command>iconv</command> in the operating system. On earlier <command>iconv</command> in the operating system. On earlier
versions, <package role="port">converters/libiconv</package> was used as a versions, <package role="port">converters/libiconv</package>
dependency.</para> was used as a dependency.</para>
<para>For software that needs <command>iconv</command>, define <para>For software that needs <command>iconv</command>, define
<literal>USES=iconv</literal>. &os; versions before <literal>USES=iconv</literal>. &os; versions before
10-CURRENT on 2013-08-13 (<revnumber>254273</revnumber>) do 10-CURRENT on 2013-08-13 (<revnumber>254273</revnumber>) do
not have a native <command>iconv</command>. On these earlier not have a native <command>iconv</command>. On these earlier
versions, a dependency on versions, a dependency on
<package role="port">converters/libiconv</package> will be added <package role="port">converters/libiconv</package> will be
automatically.</para> added automatically.</para>
<para>When a port defines <literal>USES=iconv</literal>, these <para>When a port defines <literal>USES=iconv</literal>, these
variables will be available:</para> variables will be available:</para>
@ -9655,41 +9680,48 @@ post-patch:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>libexo: <package role="port">x11/libexo</package></para> <para>libexo: <package
role="port">x11/libexo</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>libgui: <para>libgui: <package
<package role="port">x11-toolkits/libxfce4gui</package></para> role="port">x11-toolkits/libxfce4gui</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>libutil: <package role="port">x11/libxfce4util</package></para> <para>libutil: <package
role="port">x11/libxfce4util</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>libmcs: <package role="port">x11/libxfce4mcs</package></para> <para>libmcs: <package
role="port">x11/libxfce4mcs</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>mcsmanager: <para>mcsmanager: <package
<package role="port">sysutils/xfce4-mcs-manager</package></para> role="port">sysutils/xfce4-mcs-manager</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>panel: <package role="port">x11-wm/xfce4-panel</package></para> <para>panel: <package
role="port">x11-wm/xfce4-panel</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>thunar: <package role="port">x11-fm/thunar</package></para> <para>thunar: <package
role="port">x11-fm/thunar</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>wm: <package role="port">x11-wm/xfce4-wm</package></para> <para>wm: <package
role="port">x11-wm/xfce4-wm</package></para>
</listitem> </listitem>
<listitem> <listitem>
<para>xfdev: <package role="port">dev/xfce4-dev-tools</package></para> <para>xfdev: <package
role="port">dev/xfce4-dev-tools</package></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -9826,10 +9858,10 @@ post-patch:
<row> <row>
<entry><varname>USE_MYSQL</varname></entry> <entry><varname>USE_MYSQL</varname></entry>
<entry>If the variable is set to <literal>yes</literal>, add <entry>If the variable is set to <literal>yes</literal>,
a dependency on the add a dependency on the <package
<package role="port">databases/mysql55-client</package> port. An role="port">databases/mysql55-client</package> port.
associated variable, An associated variable,
<varname>WANT_MYSQL_VER</varname>, may be set to <varname>WANT_MYSQL_VER</varname>, may be set to
values such as 323, 40, 41, 50, 51, 52, 55, or values such as 323, 40, 41, 50, 51, 52, 55, or
60.</entry> 60.</entry>
@ -9838,14 +9870,15 @@ post-patch:
<row> <row>
<entry><varname>USE_PGSQL</varname></entry> <entry><varname>USE_PGSQL</varname></entry>
<entry>If set to <literal>yes</literal>, add dependency <entry>If set to <literal>yes</literal>, add dependency
on <package role="port">databases/postgresql90-client</package> on <package
role="port">databases/postgresql90-client</package>
port. An associated variable, port. An associated variable,
<varname>WANT_PGSQL_VER</varname>, may be set to <varname>WANT_PGSQL_VER</varname>, may be set to
values such as 83, 84, 90, 91 or 92. You can declare values such as 83, 84, 90, 91 or 92. You can declare
a minimum or maximum value; a minimum or maximum value;
<varname>WANT_PGSQL_VER</varname>= <varname>WANT_PGSQL_VER</varname>= <literal>
<literal> 90+</literal> will cause the 90+</literal> will cause the port to depend on a
port to depend on a minimum version of 9.0.</entry> minimum version of 9.0.</entry>
</row> </row>
<row> <row>
@ -10967,7 +11000,8 @@ as .putsy.conf and edit it.</programlisting>
how to keep up-to-date in <xref linkend="keeping-up"/>.</para> how to keep up-to-date in <xref linkend="keeping-up"/>.</para>
<sect1 xml:id="svn-diff"> <sect1 xml:id="svn-diff">
<title>Using <application>Subversion</application> to Make Patches</title> <title>Using <application>Subversion</application> to Make
Patches</title>
<para>When possible, 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 are easier to handle than diffs between
@ -10992,9 +11026,9 @@ as .putsy.conf and edit it.</programlisting>
<callout arearefs="svn-FreeBSD-org"> <callout arearefs="svn-FreeBSD-org">
<para><link <para><link
xlink:href="https://svn0.us-west.FreeBSD.org/">svn0.us-west.FreeBSD.org</link> xlink:href="https://svn0.us-west.FreeBSD.org/">svn0.us-west.FreeBSD.org</link>
is a public <application>Subversion</application> server. Select the is a public <application>Subversion</application> server.
closest mirror and verify the mirror server certificate Select the closest mirror and verify the mirror server
from the list of <link certificate from the list of <link
xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
mirror sites</link>.</para> mirror sites</link>.</para>
</callout> </callout>
@ -11017,15 +11051,16 @@ as .putsy.conf and edit it.</programlisting>
<calloutlist> <calloutlist>
<callout arearefs="svn-update"> <callout arearefs="svn-update">
<para>This will try to merge the differences between your <para>This will try to merge the differences between your
patch and current repository version; watch the output carefully. The patch and current repository version; watch the output
letter in front of each file name indicates what was done carefully. The letter in front of each file name
with it. See <xref linkend="table-svn-up"/> for a indicates what was done with it. See
complete list.</para> <xref linkend="table-svn-up"/> for a complete list.</para>
</callout> </callout>
</calloutlist> </calloutlist>
<table pgwide="1" frame="none" xml:id="table-svn-up"> <table pgwide="1" frame="none" xml:id="table-svn-up">
<title><application>Subversion</application> Update File Prefixes</title> <title><application>Subversion</application> Update File
Prefixes</title>
<tgroup cols="2"> <tgroup cols="2">
<tbody> <tbody>
@ -11058,12 +11093,12 @@ as .putsy.conf and edit it.</programlisting>
<para>If <literal>C</literal> is displayed as a result of <para>If <literal>C</literal> is displayed as a result of
<command>svn update</command>, it means something changed in <command>svn update</command>, it means something changed in
the <application>Subversion</application> repository and &man.svn.1; was not able to merge the the <application>Subversion</application> repository and
local changes with those from the repository. It is always a &man.svn.1; was not able to merge the local changes with those
good idea to inspect the changes anyway, since &man.svn.1; from the repository. It is always a good idea to inspect the
does not know anything about how a port should be, so it might changes anyway, since &man.svn.1; does not know anything about
(and probably will) merge things that do not make how a port should be, so it might (and probably will) merge
sense.</para> things that do not make sense.</para>
<para>The last step is to make a unified &man.diff.1; <para>The last step is to make a unified &man.diff.1;
of the changes:</para> of the changes:</para>
@ -11242,10 +11277,11 @@ as .putsy.conf and edit it.</programlisting>
xlink:href="http://www.freebsd.org/security/#how">&os; xlink:href="http://www.freebsd.org/security/#how">&os;
Security Information</link> page.</para> Security Information</link> page.</para>
<para>The VuXML database is an <acronym>XML</acronym> document. Its source file <para>The VuXML database is an <acronym>XML</acronym>
<filename>vuln.xml</filename> is kept right inside the port document. Its source file <filename>vuln.xml</filename> is
<package role="port">security/vuxml</package>. Therefore the file's kept right inside the port
full pathname will be <package role="port">security/vuxml</package>. Therefore
the file's full pathname will be
<filename>PORTSDIR/security/vuxml/vuln.xml</filename>. Each <filename>PORTSDIR/security/vuxml/vuln.xml</filename>. Each
time you discover a security vulnerability in a port, please time you discover a security vulnerability in a port, please
add an entry for it to that file. Until you are familiar add an entry for it to that file. Until you are familiar
@ -11257,20 +11293,20 @@ as .putsy.conf and edit it.</programlisting>
<sect2 xml:id="security-notify-vuxml-intro"> <sect2 xml:id="security-notify-vuxml-intro">
<title>A Short Introduction to VuXML</title> <title>A Short Introduction to VuXML</title>
<para>The full-blown <acronym>XML</acronym> format is complex, and far beyond the <para>The full-blown <acronym>XML</acronym> format is complex,
scope of this book. However, to gain basic insight on the and far beyond the scope of this book. However, to gain
structure of a VuXML entry you need only the notion of tags. basic insight on the structure of a VuXML entry you need
XML tag names are enclosed in angle brackets. Each opening only the notion of tags. XML tag names are enclosed in
&lt;tag&gt; must have a matching closing &lt;/tag&gt;. Tags angle brackets. Each opening &lt;tag&gt; must have a
may be nested. If nesting, the inner tags must be closed matching closing &lt;/tag&gt;. Tags may be nested. If
before the outer ones. There is a hierarchy of tags, i.e., nesting, the inner tags must be closed before the outer
more complex rules of nesting them. This is similar to ones. There is a hierarchy of tags, i.e., more complex
HTML. The major difference is that XML is rules of nesting them. This is similar to HTML. The major
e<emphasis>X</emphasis>tensible, i.e., based on defining difference is that XML is e<emphasis>X</emphasis>tensible,
custom tags. Due to its intrinsic structure XML puts i.e., based on defining custom tags. Due to its intrinsic
otherwise amorphous data into shape. VuXML is particularly structure XML puts otherwise amorphous data into shape.
tailored to mark up descriptions of security VuXML is particularly tailored to mark up descriptions of
vulnerabilities.</para> security vulnerabilities.</para>
<para>Now consider a realistic VuXML entry:</para> <para>Now consider a realistic VuXML entry:</para>
@ -11640,8 +11676,8 @@ Reference: &lt;http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00
<sect1 xml:id="dads-intro"> <sect1 xml:id="dads-intro">
<title>Introduction</title> <title>Introduction</title>
<para>Here is a list of common dos and don'ts that are encountered <para>Here is a list of common dos and don'ts that are
during the porting process. Check the port encountered during the porting process. Check the port
against this list, but also check ports in the <link against this list, but also check ports in the <link
xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">PR xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">PR
database</link> that others have submitted. Submit any database</link> that others have submitted. Submit any
@ -11695,7 +11731,8 @@ Reference: &lt;http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00
conditional compilation based upon what version of &os; Unix conditional compilation based upon what version of &os; Unix
it is running under. The preferred way to tell &os; versions it is running under. The preferred way to tell &os; versions
apart are the <literal>__FreeBSD_version</literal> and apart are the <literal>__FreeBSD_version</literal> and
<literal>__FreeBSD__</literal> macros defined in <link xlink:href="http://svnweb.freebsd.org/base/head/sys/sys/param.h?view=markup">sys/param.h</link>. <literal>__FreeBSD__</literal> macros defined in <link
xlink:href="http://svnweb.freebsd.org/base/head/sys/sys/param.h?view=markup">sys/param.h</link>.
If this file is not included add the code,</para> If this file is not included add the code,</para>
<programlisting>#include &lt;sys/param.h&gt;</programlisting> <programlisting>#include &lt;sys/param.h&gt;</programlisting>