Miscellaneous fixes included punctuation, adding missing articles,
removing some instances of "you", corrections for clarity.
This commit is contained in:
parent
8ebcaf60e1
commit
19e9a61e4f
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=43303
1 changed files with 33 additions and 37 deletions
|
@ -138,8 +138,7 @@
|
||||||
|
|
||||||
<para>This setting enables the <quote>developer mode</quote>
|
<para>This setting enables the <quote>developer mode</quote>
|
||||||
that displays deprecation warnings and activates some further
|
that displays deprecation warnings and activates some further
|
||||||
quality checks on calling the <command>make</command>
|
quality checks on calling <command>make</command>.</para>
|
||||||
command.</para>
|
|
||||||
</note>
|
</note>
|
||||||
|
|
||||||
<sect1 xml:id="porting-makefile">
|
<sect1 xml:id="porting-makefile">
|
||||||
|
@ -2551,7 +2550,7 @@ MASTER_SITE_SUBDIR= make</programlisting>
|
||||||
|
|
||||||
<programlisting>MASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
|
<programlisting>MASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
|
||||||
|
|
||||||
<para>This can be also written as</para>
|
<para>This can also be written as</para>
|
||||||
|
|
||||||
<programlisting>MASTER_SITES= SF
|
<programlisting>MASTER_SITES= SF
|
||||||
MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
|
MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
|
||||||
|
@ -3927,7 +3926,7 @@ ALWAYS_KEEP_DISTFILES= yes
|
||||||
installed when default C/C++ compiler is Clang); or
|
installed when default C/C++ compiler is Clang); or
|
||||||
<literal>yes</literal> (means always use stable,
|
<literal>yes</literal> (means always use stable,
|
||||||
modern GCC from <literal>lang/gcc</literal> port).
|
modern GCC from <literal>lang/gcc</literal> port).
|
||||||
The exact version can be also specified, with a
|
The exact version can also be specified, with a
|
||||||
value such as <literal>4.7</literal>. The minimal
|
value such as <literal>4.7</literal>. The minimal
|
||||||
required version can be specified as
|
required version can be specified as
|
||||||
<literal>4.6+</literal>. The GCC from the base
|
<literal>4.6+</literal>. The GCC from the base
|
||||||
|
@ -5293,11 +5292,11 @@ PORTVERSION= 1.0</programlisting>
|
||||||
<varname>PORTDATA</varname> and
|
<varname>PORTDATA</varname> and
|
||||||
<varname>PORTEXAMPLES</varname>, respectively.</para>
|
<varname>PORTEXAMPLES</varname>, respectively.</para>
|
||||||
|
|
||||||
<para>You can also use the <filename>pkg-message</filename>
|
<para>The contents of <filename>pkg-message</filename>
|
||||||
file to display messages upon installation. See
|
are displayed upon installation. See
|
||||||
<link linkend="porting-message">the section on using
|
<link linkend="porting-message">the section on using
|
||||||
<filename>pkg-message</filename></link> for details. The
|
<filename>pkg-message</filename></link> for details.
|
||||||
<filename>pkg-message</filename> file does not need to be
|
<filename>pkg-message</filename> does not need to be
|
||||||
added to <filename>pkg-plist</filename>.</para>
|
added to <filename>pkg-plist</filename>.</para>
|
||||||
</note>
|
</note>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
@ -7150,7 +7149,7 @@ USE_QT4= qmake_build</programlisting>
|
||||||
</row>
|
</row>
|
||||||
|
|
||||||
<row>
|
<row>
|
||||||
<entry>smokekde<literal/></entry>
|
<entry><literal>smokekde</literal></entry>
|
||||||
<entry>KDE SMOKE libraries</entry>
|
<entry>KDE SMOKE libraries</entry>
|
||||||
</row>
|
</row>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -7981,8 +7980,7 @@ _DOCSDIR= .
|
||||||
|
|
||||||
<programlisting>(cd ${STAGEDIR}${PREFIX} \
|
<programlisting>(cd ${STAGEDIR}${PREFIX} \
|
||||||
&& ${PYTHON_CMD} ${PYTHON_LIBDIR}/compileall.py \
|
&& ${PYTHON_CMD} ${PYTHON_LIBDIR}/compileall.py \
|
||||||
-d ${PREFIX} -f ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;})
|
-d ${PREFIX} -f ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;})</programlisting>
|
||||||
</programlisting>
|
|
||||||
|
|
||||||
<para>This recompiles the sources with a path relative to the
|
<para>This recompiles the sources with a path relative to the
|
||||||
stage directory, and prepends the value of
|
stage directory, and prepends the value of
|
||||||
|
@ -9817,8 +9815,8 @@ post-patch:
|
||||||
|
|
||||||
<row>
|
<row>
|
||||||
<entry><varname>USE_MYSQL</varname></entry>
|
<entry><varname>USE_MYSQL</varname></entry>
|
||||||
<entry>If variable is set to <literal>yes</literal>, add
|
<entry>If the variable is set to <literal>yes</literal>, add
|
||||||
dependency on
|
a dependency on the
|
||||||
<package>databases/mysql55-client</package> port. An
|
<package>databases/mysql55-client</package> port. An
|
||||||
associated variable,
|
associated variable,
|
||||||
<varname>WANT_MYSQL_VER</varname>, may be set to
|
<varname>WANT_MYSQL_VER</varname>, may be set to
|
||||||
|
@ -9866,7 +9864,7 @@ post-patch:
|
||||||
framework. Details on its usage can be found in <link
|
framework. Details on its usage can be found in <link
|
||||||
xlink:href="&url.books.handbook;/configtuning-rcd.html">the
|
xlink:href="&url.books.handbook;/configtuning-rcd.html">the
|
||||||
rc.d Handbook chapter</link>. Detailed explanation of
|
rc.d Handbook chapter</link>. Detailed explanation of
|
||||||
available commands is provided in &man.rc.8; and
|
the available commands is provided in &man.rc.8; and
|
||||||
&man.rc.subr.8;. Finally, there is
|
&man.rc.subr.8;. Finally, there is
|
||||||
<link xlink:href="&url.articles.rc-scripting;">an
|
<link xlink:href="&url.articles.rc-scripting;">an
|
||||||
article</link> on practical aspects of
|
article</link> on practical aspects of
|
||||||
|
@ -10850,7 +10848,7 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
to keep your whole ports collection up-to-date, as described in
|
to keep your whole ports collection up-to-date, as described in
|
||||||
the <link
|
the <link
|
||||||
xlink:href="&url.books.handbook;/ports-using.html">Handbook</link>.
|
xlink:href="&url.books.handbook;/ports-using.html">Handbook</link>.
|
||||||
This will have the added benefit of tracking all the ports'
|
This will have the added benefit of tracking all the port's
|
||||||
dependencies.</para>
|
dependencies.</para>
|
||||||
|
|
||||||
<para>The next step is to see if there is an update already
|
<para>The next step is to see if there is an update already
|
||||||
|
@ -10942,17 +10940,17 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
more than about 20KB, please compress and uuencode it;
|
more than about 20KB, please compress and uuencode it;
|
||||||
otherwise, just include it in the PR as is.</para>
|
otherwise, just include it in the PR as is.</para>
|
||||||
|
|
||||||
<para>Before you &man.send-pr.1;, you should review the <link
|
<para>Before using &man.send-pr.1;, review the <link
|
||||||
xlink:href="&url.articles.problem-reports;/pr-writing.html">
|
xlink:href="&url.articles.problem-reports;/pr-writing.html">
|
||||||
Writing the problem report</link> section in the Problem
|
Writing the problem report</link> section in the Problem
|
||||||
Reports article; it contains far more information about how to
|
Reports article. It contains far more information about how to
|
||||||
write useful problem reports.</para>
|
write useful problem reports.</para>
|
||||||
|
|
||||||
<important>
|
<important>
|
||||||
<para>If your upgrade is motivated by security concerns or a
|
<para>If the upgrade is motivated by security concerns or a
|
||||||
serious fault in the currently committed port, please notify
|
serious fault in the currently committed port, please notify
|
||||||
the &a.portmgr; to request immediate rebuilding and
|
the &a.portmgr; to request immediate rebuilding and
|
||||||
redistribution of your port's package. Unsuspecting users
|
redistribution of the port's package. Unsuspecting users
|
||||||
of &man.pkg.add.1; will otherwise continue to install the
|
of &man.pkg.add.1; will otherwise continue to install the
|
||||||
old version via <command>pkg_add -r</command> for several
|
old version via <command>pkg_add -r</command> for several
|
||||||
weeks.</para>
|
weeks.</para>
|
||||||
|
@ -10964,7 +10962,7 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
committers understand exactly what is being changed.</para>
|
committers understand exactly what is being changed.</para>
|
||||||
</note>
|
</note>
|
||||||
|
|
||||||
<para>Now that you have done all that, you will want to read about
|
<para>Now that you have done all that, read about
|
||||||
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">
|
||||||
|
@ -11223,12 +11221,12 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
package without delay as soon as a corrected version is
|
package without delay as soon as a corrected version is
|
||||||
available.</para>
|
available.</para>
|
||||||
|
|
||||||
<para>Given the huge number of ports in the tree a security
|
<para>Given the huge number of ports in the tree, a security
|
||||||
advisory cannot be issued on each incident without creating
|
advisory cannot be issued on each incident without creating
|
||||||
a flood and losing the attention of the audience when it
|
a flood and losing the attention of the audience when it
|
||||||
comes to really serious matters. Therefore security
|
comes to really serious matters. Therefore security
|
||||||
vulnerabilities found in ports are recorded in
|
vulnerabilities found in ports are recorded in
|
||||||
<link xlink:href="http://vuxml.freebsd.org/">the FreeBSD
|
<link xlink:href="http://vuxml.freebsd.org/">the &os;
|
||||||
VuXML database</link>. The Security Officer Team members
|
VuXML database</link>. The Security Officer Team members
|
||||||
also monitor it for issues requiring their
|
also monitor it for issues requiring their
|
||||||
intervention.</para>
|
intervention.</para>
|
||||||
|
@ -11240,15 +11238,15 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
you believe you have found an exceptionally severe
|
you believe you have found an exceptionally severe
|
||||||
vulnerability please do not hesitate to contact the Security
|
vulnerability please do not hesitate to contact the Security
|
||||||
Officer Team directly as described on the <link
|
Officer Team directly as described on the <link
|
||||||
xlink:href="http://www.freebsd.org/security/#how">FreeBSD
|
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 XML document. Its source file
|
<para>The VuXML database is an <acronym>XML</acronym> document. Its source file
|
||||||
<filename>vuln.xml</filename> is kept right inside the port
|
<filename>vuln.xml</filename> is kept right inside the port
|
||||||
<package>security/vuxml</package>. Therefore the file's
|
<package>security/vuxml</package>. Therefore the file's
|
||||||
full pathname will be
|
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
|
||||||
with VuXML, the best thing you can do is to find an existing
|
with VuXML, the best thing you can do is to find an existing
|
||||||
entry fitting your case, then copy it and use it as a
|
entry fitting your case, then copy it and use it as a
|
||||||
|
@ -11258,7 +11256,7 @@ 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 XML format is complex, and far beyond the
|
<para>The full-blown <acronym>XML</acronym> format is complex, and far beyond the
|
||||||
scope of this book. However, to gain basic insight on the
|
scope of this book. However, to gain basic insight on the
|
||||||
structure of a VuXML entry you need only the notion of tags.
|
structure of a VuXML entry you need only the notion of tags.
|
||||||
XML tag names are enclosed in angle brackets. Each opening
|
XML tag names are enclosed in angle brackets. Each opening
|
||||||
|
@ -11458,13 +11456,13 @@ as .putsy.conf and edit it.</programlisting>
|
||||||
|
|
||||||
<callout arearefs="co-vx-fsa">
|
<callout arearefs="co-vx-fsa">
|
||||||
<para>This is a <link
|
<para>This is a <link
|
||||||
xlink:href="http://www.freebsd.org/security/#adv">FreeBSD
|
xlink:href="http://www.freebsd.org/security/#adv">&os;
|
||||||
security advisory</link>.</para>
|
security advisory</link>.</para>
|
||||||
</callout>
|
</callout>
|
||||||
|
|
||||||
<callout arearefs="co-vx-fpr">
|
<callout arearefs="co-vx-fpr">
|
||||||
<para>This is a <link
|
<para>This is a <link
|
||||||
xlink:href="http://www.freebsd.org/support.html#gnats">FreeBSD
|
xlink:href="http://www.freebsd.org/support.html#gnats">&os;
|
||||||
problem report</link>.</para>
|
problem report</link>.</para>
|
||||||
</callout>
|
</callout>
|
||||||
|
|
||||||
|
@ -11641,9 +11639,9 @@ Reference: <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 you encounter
|
<para>Here is a list of common dos and don'ts that are encountered
|
||||||
during the porting process. You should check your own port
|
during the porting process. Check the port
|
||||||
against this list, but you can 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
|
||||||
comments on ports you check as described in <link
|
comments on ports you check as described in <link
|
||||||
|
@ -11709,13 +11707,11 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00
|
||||||
example, in &os; 9.x, <literal>__FreeBSD__</literal> is
|
example, in &os; 9.x, <literal>__FreeBSD__</literal> is
|
||||||
defined to be <literal>9</literal>.</para>
|
defined to be <literal>9</literal>.</para>
|
||||||
|
|
||||||
<para>
|
<programlisting>#if __FreeBSD__ >= 9
|
||||||
<programlisting>#if __FreeBSD__ >= 9
|
|
||||||
# if __FreeBSD_version >= 901000
|
# if __FreeBSD_version >= 901000
|
||||||
/* 9.1+ release specific code here */
|
/* 9.1+ release specific code here */
|
||||||
# endif
|
# endif
|
||||||
#endif</programlisting>
|
#endif</programlisting>
|
||||||
</para>
|
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
<sect1 xml:id="dads-after-port-mk">
|
<sect1 xml:id="dads-after-port-mk">
|
||||||
|
@ -11981,9 +11977,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting>
|
||||||
<sect1 xml:id="dads-readme">
|
<sect1 xml:id="dads-readme">
|
||||||
<title><filename>README.html</filename></title>
|
<title><filename>README.html</filename></title>
|
||||||
|
|
||||||
<para>Do not include the <filename>README.html</filename> file.
|
<para><filename>README.html</filename> is not part of the port,
|
||||||
This file is not part of the SVN collection but is generated
|
but generated by <command>make readme</command>. Do not
|
||||||
using the <command>make readme</command> command.</para>
|
include this file in patches or commits.</para>
|
||||||
|
|
||||||
<note>
|
<note>
|
||||||
<para>If <command>make readme</command> fails, make sure that
|
<para>If <command>make readme</command> fails, make sure that
|
||||||
|
|
Loading…
Reference in a new issue