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

Whitespace-only fixes, indentation and wrapping long lines.

Browse source 
Translators, please ignore.

Sponsored by:	Absolight
Differential Revision: https://phabric.freebsd.org/605
This commit is contained in:
Mathieu Arnold 2014-08-14 13:13:23 +00:00
parent 19e0329144
commit 13ac525006
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=45455
8 changed files with 82 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
View file

@ -3546,10 +3546,9 @@ OPT5_DESC= Describe OPT5
OPT6_DESC= Describe OPT6</programlisting> OPT6_DESC= Describe OPT6</programlisting>
<para><filename>ports/Mk/bsd.options.desc.mk</filename> <para><filename>ports/Mk/bsd.options.desc.mk</filename>
has descriptions for many common has descriptions for many common <varname>OPTIONS</varname>.
<varname>OPTIONS</varname>. While often useful, they While often useful, they should be overridden if the
should be overridden if the description is insufficient description is insufficient for the port.</para>
for the port.</para>
<tip> <tip>
<para>When describing options, view it from the <para>When describing options, view it from the
@ -3823,8 +3822,8 @@ SUB_LIST+= OPT1="@comment " NO_OPT1=""
<varname>USE_<replaceable>KEY</replaceable></varname> <varname>USE_<replaceable>KEY</replaceable></varname>
variable will be set to <replaceable>value</replaceable>. variable will be set to <replaceable>value</replaceable>.
If <replaceable>value</replaceable> has spaces in it, If <replaceable>value</replaceable> has spaces in it,
replace them with commas, they will be changed back to spaces replace them with commas, they will be changed back to
during processing. For example:</para> spaces during processing. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting> OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting>
@ -3884,7 +3883,7 @@ CONFIGURE_ARGS+= --disable-test
on the status of the option on the status of the option
<literal><replaceable>OPT</replaceable></literal>. An <literal><replaceable>OPT</replaceable></literal>. An
optional argument can be specified with an optional argument can be specified with an
<literal>=</literal> symbol. This argument is only appended <literal>=</literal> symbol. This argument is only appended
to the to the
<literal>--with-<replaceable>opt</replaceable></literal> <literal>--with-<replaceable>opt</replaceable></literal>
configure option. For example:</para> configure option. For example:</para>

22
en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml
View file

@ -12,8 +12,8 @@
<title>The <filename>pkg-*</filename> Files</title> <title>The <filename>pkg-*</filename> Files</title>
<para>There are some tricks we have not mentioned yet about the <para>There are some tricks we have not mentioned yet about the
<filename>pkg-<replaceable>*</replaceable></filename> files that come in handy <filename>pkg-<replaceable>*</replaceable></filename> files that
sometimes.</para> come in handy sometimes.</para>
<sect1 xml:id="porting-message"> <sect1 xml:id="porting-message">
<title><filename>pkg-message</filename></title> <title><filename>pkg-message</filename></title>
@ -84,16 +84,20 @@
<sect1 xml:id="pkg-names"> <sect1 xml:id="pkg-names">
<title xml:id="porting-pkgfiles">Changing the Names of <title xml:id="porting-pkgfiles">Changing the Names of
<filename>pkg-<replaceable>*</replaceable></filename> Files</title> <filename>pkg-<replaceable>*</replaceable></filename>
Files</title>
<para>All the names of <filename>pkg-<replaceable>*</replaceable></filename> files are <para>All the names of
<filename>pkg-<replaceable>*</replaceable></filename> files are
defined using variables so you can change them in your defined using variables so you can change them in your
<filename>Makefile</filename> if need be. This is especially <filename>Makefile</filename> if need be. This is especially
useful when you are sharing the same <filename>pkg-<replaceable>*</replaceable></filename> useful when you are sharing the same
files among several ports or have to write to one of the above <filename>pkg-<replaceable>*</replaceable></filename> files
files (see <link linkend="porting-wrkdir">writing to places among several ports or have to write to one of the above files
other than <varname>WRKDIR</varname></link> for why it is a (see <link linkend="porting-wrkdir">writing to places other than
bad idea to write directly into the <filename>pkg-<replaceable>*</replaceable></filename> <varname>WRKDIR</varname></link> for why it is a bad idea to
write directly into the
<filename>pkg-<replaceable>*</replaceable></filename>
subdirectory).</para> subdirectory).</para>
<para>Here is a list of variable names and their default values. <para>Here is a list of variable names and their default values.

37
en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
View file

@ -28,16 +28,18 @@
<literal>4.9</literal>). <literal>%%PERL_VERSION%%</literal> <literal>4.9</literal>). <literal>%%PERL_VERSION%%</literal>
and <literal>%%PERL_VER%%</literal> is the full version number and <literal>%%PERL_VER%%</literal> is the full version number
of <command>perl</command> (e.g., <literal>5.8.9</literal>). of <command>perl</command> (e.g., <literal>5.8.9</literal>).
Several other <literal>%%<replaceable>VARS</replaceable>%%</literal> related to port's Several other
documentation files are described in <literal>%%<replaceable>VARS</replaceable>%%</literal> related
<link linkend="install-documentation">the relevant to port's documentation files are described in <link
linkend="install-documentation">the relevant
section</link>.</para> section</link>.</para>
<para>If you need to make other substitutions, you can set the <para>If you need to make other substitutions, you can set the
<varname>PLIST_SUB</varname> variable with a list of <varname>PLIST_SUB</varname> variable with a list of
<literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal> pairs and instances of <literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal>
<literal>%%<replaceable>VAR</replaceable>%%</literal> will be substituted with pairs and instances of
<replaceable>VALUE</replaceable> in the <literal>%%<replaceable>VAR</replaceable>%%</literal> will be
substituted with <replaceable>VALUE</replaceable> in the
<filename>pkg-plist</filename>.</para> <filename>pkg-plist</filename>.</para>
<para>For instance, if you have a port that installs many files <para>For instance, if you have a port that installs many files
@ -97,11 +99,12 @@ OPTIONS_SUB= yes</programlisting>
<filename>PLIST</filename> contents. Names listed in <filename>PLIST</filename> contents. Names listed in
<varname>PLIST_FILES</varname>, <varname>PLIST_DIRS</varname>, <varname>PLIST_FILES</varname>, <varname>PLIST_DIRS</varname>,
and <varname>PLIST_DIRSTRY</varname> are subject to and <varname>PLIST_DIRSTRY</varname> are subject to
<literal>%%<replaceable>VAR</replaceable>%%</literal> substitution as described above. <literal>%%<replaceable>VAR</replaceable>%%</literal>
Except for that, names from <varname>PLIST_FILES</varname> will substitution as described above. Except for that, names from
appear in the final packing list unchanged, while <varname>PLIST_FILES</varname> will appear in the final packing
<literal>@dirrm</literal> and <literal>@dirrmtry</literal> will list unchanged, while <literal>@dirrm</literal> and
be prepended to names from <varname>PLIST_DIRS</varname> and <literal>@dirrmtry</literal> will be prepended to names from
<varname>PLIST_DIRS</varname> and
<varname>PLIST_DIRSTRY</varname>, respectively. To take effect, <varname>PLIST_DIRSTRY</varname>, respectively. To take effect,
<varname>PLIST_FILES</varname>, <varname>PLIST_DIRS</varname>, <varname>PLIST_FILES</varname>, <varname>PLIST_DIRS</varname>,
and <varname>PLIST_DIRSTRY</varname> must be set before and <varname>PLIST_DIRSTRY</varname> must be set before
@ -294,14 +297,14 @@ etc/orbit.conf-dist
can get it wrong.</para> can get it wrong.</para>
<para>User configuration files should be installed as <para>User configuration files should be installed as
<filename><replaceable>filename</replaceable>.sample</filename>, as it is described in <filename><replaceable>filename</replaceable>.sample</filename>,
<xref linkend="plist-config"/>. The as it is described in <xref linkend="plist-config"/>. The
<filename>info/dir</filename> file should not be listed and <filename>info/dir</filename> file should not be listed and
appropriate <filename>install-info</filename> lines should be appropriate <filename>install-info</filename> lines should be
added as noted in the added as noted in the <link linkend="makefile-info">info
<link linkend="makefile-info">info files</link> section. Any files</link> section. Any libraries installed by the port
libraries installed by the port should be listed as specified in should be listed as specified in the <link
the <link linkend="porting-shlibs">shared libraries</link> linkend="porting-shlibs">shared libraries</link>
section.</para> section.</para>
</sect1> </sect1>

22
en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
View file

@ -36,9 +36,9 @@
xlink:href="&url.books.handbook;/ports-using.html#PORTS-CD"> xlink:href="&url.books.handbook;/ports-using.html#PORTS-CD">
installing ports from a CDROM</link> for an example of installing ports from a CDROM</link> for an example of
building ports from a read-only tree). If you need to modify building ports from a read-only tree). If you need to modify
one of the <filename>pkg-<replaceable>*</replaceable></filename> files, do so by one of the <filename>pkg-<replaceable>*</replaceable></filename>
<link linkend="pkg-names">redefining a variable</link>, files, do so by <link linkend="pkg-names">redefining a
not by writing over it.</para> variable</link>, not by writing over it.</para>
</sect1> </sect1>
<sect1 xml:id="porting-wrkdirprefix"> <sect1 xml:id="porting-wrkdirprefix">
@ -48,10 +48,12 @@
Most ports do not have to worry about this. In particular, if Most ports do not have to worry about this. In particular, if
you are referring to a <varname>WRKDIR</varname> of another you are referring to a <varname>WRKDIR</varname> of another
port, note that the correct location is port, note that the correct location is
<filename>WRKDIRPREFIXPORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> not <filename>WRKDIRPREFIXPORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
<filename>PORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or not
<filename>.CURDIR/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or some <filename>PORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
such.</para> or
<filename>.CURDIR/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
or some such.</para>
<para>Also, if you are defining <varname>WRKDIR</varname> <para>Also, if you are defining <varname>WRKDIR</varname>
yourself, make sure you prepend yourself, make sure you prepend
@ -386,9 +388,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><varname>BROKEN</varname> is reserved for ports that <para><varname>BROKEN</varname> is reserved for ports that
currently do not compile, install, deinstall, or run correctly. currently do not compile, install, deinstall, or run
It should be used for ports where the problem is believed correctly. It should be used for ports where the problem
to be temporary.</para> is believed to be temporary.</para>
<para>If instructed, the build cluster will still attempt <para>If instructed, the build cluster will still attempt
to try to build them to see if the underlying problem has to try to build them to see if the underlying problem has

14
en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
View file

@ -21,9 +21,10 @@
<note> <note>
<para>The following steps assume that the software compiled <para>The following steps assume that the software compiled
out-of-the-box. In other words, absolutely no changes were required out-of-the-box. In other words, absolutely no changes were
for the application to work on a &os; system. If anything had to be required for the application to work on a &os; system. If
changed, refer to <xref linkend="slow-porting"/>.</para> anything had to be changed, refer to <xref
linkend="slow-porting"/>.</para>
</note> </note>
<note> <note>
@ -208,8 +209,8 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
</note> </note>
<para>The price for this way of listing a port's files and <para>The price for this way of listing a port's files and
directories is that then command sequences directories is that then command sequences described in
described in &man.pkg-create.8; cannot be used. Therefore, it is suitable &man.pkg-create.8; cannot be used. Therefore, it is suitable
only for simple ports and makes them even simpler. At the only for simple ports and makes them even simpler. At the
same time, it has the advantage of reducing the number of same time, it has the advantage of reducing the number of
files in the ports collection. Please consider using this files in the ports collection. Please consider using this
@ -294,7 +295,8 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
</step> </step>
<step> <step>
<para><command>pkg add <replaceable>package-filename</replaceable></command></para> <para><command>pkg add
<replaceable>package-filename</replaceable></command></para>
</step> </step>
<step> <step>

14
en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml
View file

@ -59,8 +59,8 @@
<para>The <buildtarget>patch</buildtarget> target is run. <para>The <buildtarget>patch</buildtarget> target is run.
First, any patches defined in <varname>PATCHFILES</varname> First, any patches defined in <varname>PATCHFILES</varname>
are applied. Second, if any patch files named are applied. Second, if any patch files named
<filename>patch-<replaceable>*</replaceable></filename> are found in <filename>patch-<replaceable>*</replaceable></filename> are
<varname>PATCHDIR</varname> (defaults to the found in <varname>PATCHDIR</varname> (defaults to the
<filename>files</filename> subdirectory), they are applied <filename>files</filename> subdirectory), they are applied
at this time in alphabetical order.</para> at this time in alphabetical order.</para>
</step> </step>
@ -170,8 +170,8 @@
<para>Get the original sources (normally) as a compressed tarball <para>Get the original sources (normally) as a compressed tarball
(<filename>foo.tar.gz</filename> or (<filename>foo.tar.gz</filename> or
<filename><replaceable>foo</replaceable>.tar.bz2</filename>) and copy it into <filename><replaceable>foo</replaceable>.tar.bz2</filename>) and
<varname>DISTDIR</varname>. Always use copy it into <varname>DISTDIR</varname>. Always use
<emphasis>mainstream</emphasis> sources when and where you <emphasis>mainstream</emphasis> sources when and where you
can.</para> can.</para>
@ -344,7 +344,7 @@
<note> <note>
<para>Manual patch creation is usually not necessary. <para>Manual patch creation is usually not necessary.
Automatic patch generation as described earlier in this Automatic patch generation as described earlier in this
section is the preferred method. However, manual patching section is the preferred method. However, manual patching
may be required occasionally.</para> may be required occasionally.</para>
</note> </note>
@ -369,8 +369,8 @@
<screen>&prompt.user; <userinput>diff -u -N <replaceable>newfile</replaceable>.orig <replaceable>newfile</replaceable> &gt; patch-<replaceable>pathname-newfile</replaceable></userinput></screen> <screen>&prompt.user; <userinput>diff -u -N <replaceable>newfile</replaceable>.orig <replaceable>newfile</replaceable> &gt; patch-<replaceable>pathname-newfile</replaceable></userinput></screen>
<para>Do not add <literal>&dollar;FreeBSD&dollar;</literal> RCS strings in <para>Do not add <literal>&dollar;FreeBSD&dollar;</literal> RCS
patches. When patches are added to the strings in patches. When patches are added to the
<application>Subversion</application> repository with <application>Subversion</application> repository with
<command>svn add</command>, the <command>svn add</command>, the
<literal>fbsd:nokeywords</literal> property is set to <literal>fbsd:nokeywords</literal> property is set to

19
en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
View file

@ -810,8 +810,9 @@ CMAKE_SOURCE_PATH= &dollar;{WRKSRC}/subproject</programlisting>
libtool (search for a file named ltmain.sh) need to have libtool (search for a file named ltmain.sh) need to have
<literal>USES=libtool</literal>. Also, if a port has <literal>USES=libtool</literal>. Also, if a port has
<literal>USE_AUTOTOOLS=libtoolize</literal> it probably also <literal>USE_AUTOTOOLS=libtoolize</literal> it probably also
needs <literal>USES=libtool</literal>. See the <link linkend="uses-libtool">USES=libtool</link> needs <literal>USES=libtool</literal>. See the <link
section in <xref linkend="uses"/> for more details.</para> linkend="uses-libtool">USES=libtool</link> section in <xref
linkend="uses"/> for more details.</para>
</sect2> </sect2>
@ -1342,9 +1343,10 @@ USE_XORG= x11 xpm</programlisting>
<title>Updating Desktop Database</title> <title>Updating Desktop Database</title>
<para>If a port has a MimeType entry in its <para>If a port has a MimeType entry in its
<filename><replaceable>portname</replaceable>.desktop</filename>, the desktop database <filename><replaceable>portname</replaceable>.desktop</filename>,
must be updated after install and deinstall. To do this, the desktop database must be updated after install and
define <varname>USES</varname>= desktop-file-utils.</para> deinstall. To do this, define <varname>USES</varname>=
desktop-file-utils.</para>
</sect3> </sect3>
<sect3 xml:id="desktop-entries-macro"> <sect3 xml:id="desktop-entries-macro">
@ -1352,9 +1354,10 @@ USE_XORG= x11 xpm</programlisting>
<varname>DESKTOP_ENTRIES</varname> Macro</title> <varname>DESKTOP_ENTRIES</varname> Macro</title>
<para>Desktop entries can be easily created for applications <para>Desktop entries can be easily created for applications
by using the <varname>DESKTOP_ENTRIES</varname> variable. A by using the <varname>DESKTOP_ENTRIES</varname> variable. A
file named <filename><replaceable>name</replaceable>.desktop</filename> will be file named
created, installed, and added to the <filename><replaceable>name</replaceable>.desktop</filename>
will be created, installed, and added to the
<filename>pkg-plist</filename> automatically. Syntax <filename>pkg-plist</filename> automatically. Syntax
is:</para> is:</para>

9
en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
View file

@ -987,13 +987,14 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi</programlisting>
<entry>(none), <literal>Z</literal>, <literal>bz2</literal>, <entry>(none), <literal>Z</literal>, <literal>bz2</literal>,
<literal>bzip2</literal>, <literal>lzma</literal>, <literal>bzip2</literal>, <literal>lzma</literal>,
<literal>tbz</literal>, <literal>tgz</literal>, <literal>txz</literal>, <literal>tbz</literal>, <literal>tgz</literal>,
<literal>xz</literal></entry> <literal>txz</literal>, <literal>xz</literal></entry>
<entry>Set <varname>EXTRACT_SUFX</varname> to <entry>Set <varname>EXTRACT_SUFX</varname> to
<literal>.tar</literal>, <literal>.tar.Z</literal>, <literal>.tar</literal>, <literal>.tar.Z</literal>,
<literal>.tar.bz2</literal>, <literal>.tar.bz2</literal>, <literal>.tar.lzma</literal>, <literal>.tar.bz2</literal>, <literal>.tar.bz2</literal>,
<literal>.tbz</literal>, <literal>.tgz</literal>, <literal>.txz</literal> or <literal>.tar.lzma</literal>, <literal>.tbz</literal>,
<literal>.tgz</literal>, <literal>.txz</literal> or
<literal>.tar.xz</literal> respectively.</entry> <literal>.tar.xz</literal> respectively.</entry>
</row> </row>