Whitespace-only fixes, indentation and wrapping long lines.
Translators, please ignore. Sponsored by: Absolight Differential Revision: https://phabric.freebsd.org/605
This commit is contained in:
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
|
@ -3546,10 +3546,9 @@ OPT5_DESC= Describe OPT5
|
|||
OPT6_DESC= Describe OPT6</programlisting>
|
||||
|
||||
<para><filename>ports/Mk/bsd.options.desc.mk</filename>
|
||||
has descriptions for many common
|
||||
<varname>OPTIONS</varname>. While often useful, they
|
||||
should be overridden if the description is insufficient
|
||||
for the port.</para>
|
||||
has descriptions for many common <varname>OPTIONS</varname>.
|
||||
While often useful, they should be overridden if the
|
||||
description is insufficient for the port.</para>
|
||||
|
||||
<tip>
|
||||
<para>When describing options, view it from the
|
||||
|
@ -3823,8 +3822,8 @@ SUB_LIST+= OPT1="@comment " NO_OPT1=""
|
|||
<varname>USE_<replaceable>KEY</replaceable></varname>
|
||||
variable will be set to <replaceable>value</replaceable>.
|
||||
If <replaceable>value</replaceable> has spaces in it,
|
||||
replace them with commas, they will be changed back to spaces
|
||||
during processing. For example:</para>
|
||||
replace them with commas, they will be changed back to
|
||||
spaces during processing. For example:</para>
|
||||
|
||||
<programlisting>OPTIONS_DEFINE= OPT1
|
||||
OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting>
|
||||
|
@ -3884,7 +3883,7 @@ CONFIGURE_ARGS+= --disable-test
|
|||
on the status of the option
|
||||
<literal><replaceable>OPT</replaceable></literal>. 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
|
||||
<literal>--with-<replaceable>opt</replaceable></literal>
|
||||
configure option. For example:</para>
|
||||
|
|
|
@ -12,8 +12,8 @@
|
|||
<title>The <filename>pkg-*</filename> Files</title>
|
||||
|
||||
<para>There are some tricks we have not mentioned yet about the
|
||||
<filename>pkg-<replaceable>*</replaceable></filename> files that come in handy
|
||||
sometimes.</para>
|
||||
<filename>pkg-<replaceable>*</replaceable></filename> files that
|
||||
come in handy sometimes.</para>
|
||||
|
||||
<sect1 xml:id="porting-message">
|
||||
<title><filename>pkg-message</filename></title>
|
||||
|
@ -84,16 +84,20 @@
|
|||
|
||||
<sect1 xml:id="pkg-names">
|
||||
<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
|
||||
<filename>Makefile</filename> if need be. This is especially
|
||||
useful when you are sharing the same <filename>pkg-<replaceable>*</replaceable></filename>
|
||||
files among several ports or have to write to one of the above
|
||||
files (see <link linkend="porting-wrkdir">writing to places
|
||||
other than <varname>WRKDIR</varname></link> for why it is a
|
||||
bad idea to write directly into the <filename>pkg-<replaceable>*</replaceable></filename>
|
||||
useful when you are sharing the same
|
||||
<filename>pkg-<replaceable>*</replaceable></filename> files
|
||||
among several ports or have to write to one of the above files
|
||||
(see <link linkend="porting-wrkdir">writing to places other than
|
||||
<varname>WRKDIR</varname></link> for why it is a bad idea to
|
||||
write directly into the
|
||||
<filename>pkg-<replaceable>*</replaceable></filename>
|
||||
subdirectory).</para>
|
||||
|
||||
<para>Here is a list of variable names and their default values.
|
||||
|
|
|
@ -28,16 +28,18 @@
|
|||
<literal>4.9</literal>). <literal>%%PERL_VERSION%%</literal>
|
||||
and <literal>%%PERL_VER%%</literal> is the full version number
|
||||
of <command>perl</command> (e.g., <literal>5.8.9</literal>).
|
||||
Several other <literal>%%<replaceable>VARS</replaceable>%%</literal> related to port's
|
||||
documentation files are described in
|
||||
<link linkend="install-documentation">the relevant
|
||||
Several other
|
||||
<literal>%%<replaceable>VARS</replaceable>%%</literal> related
|
||||
to port's documentation files are described in <link
|
||||
linkend="install-documentation">the relevant
|
||||
section</link>.</para>
|
||||
|
||||
<para>If you need to make other substitutions, you can set the
|
||||
<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>%%</literal> will be substituted with
|
||||
<replaceable>VALUE</replaceable> in the
|
||||
<literal><replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable></literal>
|
||||
pairs and instances of
|
||||
<literal>%%<replaceable>VAR</replaceable>%%</literal> will be
|
||||
substituted with <replaceable>VALUE</replaceable> in the
|
||||
<filename>pkg-plist</filename>.</para>
|
||||
|
||||
<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
|
||||
<varname>PLIST_FILES</varname>, <varname>PLIST_DIRS</varname>,
|
||||
and <varname>PLIST_DIRSTRY</varname> are subject to
|
||||
<literal>%%<replaceable>VAR</replaceable>%%</literal> substitution as described above.
|
||||
Except for that, names from <varname>PLIST_FILES</varname> will
|
||||
appear in the final packing list unchanged, while
|
||||
<literal>@dirrm</literal> and <literal>@dirrmtry</literal> will
|
||||
be prepended to names from <varname>PLIST_DIRS</varname> and
|
||||
<literal>%%<replaceable>VAR</replaceable>%%</literal>
|
||||
substitution as described above. Except for that, names from
|
||||
<varname>PLIST_FILES</varname> will appear in the final packing
|
||||
list unchanged, while <literal>@dirrm</literal> 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_FILES</varname>, <varname>PLIST_DIRS</varname>,
|
||||
and <varname>PLIST_DIRSTRY</varname> must be set before
|
||||
|
@ -294,14 +297,14 @@ etc/orbit.conf-dist
|
|||
can get it wrong.</para>
|
||||
|
||||
<para>User configuration files should be installed as
|
||||
<filename><replaceable>filename</replaceable>.sample</filename>, as it is described in
|
||||
<xref linkend="plist-config"/>. The
|
||||
<filename><replaceable>filename</replaceable>.sample</filename>,
|
||||
as it is described in <xref linkend="plist-config"/>. The
|
||||
<filename>info/dir</filename> file should not be listed and
|
||||
appropriate <filename>install-info</filename> lines should be
|
||||
added as noted in the
|
||||
<link linkend="makefile-info">info files</link> section. Any
|
||||
libraries installed by the port should be listed as specified in
|
||||
the <link linkend="porting-shlibs">shared libraries</link>
|
||||
added as noted in the <link linkend="makefile-info">info
|
||||
files</link> section. Any libraries installed by the port
|
||||
should be listed as specified in the <link
|
||||
linkend="porting-shlibs">shared libraries</link>
|
||||
section.</para>
|
||||
</sect1>
|
||||
|
||||
|
|
|
@ -36,9 +36,9 @@
|
|||
xlink:href="&url.books.handbook;/ports-using.html#PORTS-CD">
|
||||
installing ports from a CDROM</link> for an example of
|
||||
building ports from a read-only tree). If you need to modify
|
||||
one of the <filename>pkg-<replaceable>*</replaceable></filename> files, do so by
|
||||
<link linkend="pkg-names">redefining a variable</link>,
|
||||
not by writing over it.</para>
|
||||
one of the <filename>pkg-<replaceable>*</replaceable></filename>
|
||||
files, do so by <link linkend="pkg-names">redefining a
|
||||
variable</link>, not by writing over it.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="porting-wrkdirprefix">
|
||||
|
@ -48,10 +48,12 @@
|
|||
Most ports do not have to worry about this. In particular, if
|
||||
you are referring to a <varname>WRKDIR</varname> of another
|
||||
port, note that the correct location is
|
||||
<filename>WRKDIRPREFIXPORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> not
|
||||
<filename>PORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or
|
||||
<filename>.CURDIR/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename> or some
|
||||
such.</para>
|
||||
<filename>WRKDIRPREFIXPORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
|
||||
not
|
||||
<filename>PORTSDIR/<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
|
||||
or
|
||||
<filename>.CURDIR/../../<replaceable>subdir</replaceable>/<replaceable>name</replaceable>/work</filename>
|
||||
or some such.</para>
|
||||
|
||||
<para>Also, if you are defining <varname>WRKDIR</varname>
|
||||
yourself, make sure you prepend
|
||||
|
@ -386,9 +388,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting>
|
|||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><varname>BROKEN</varname> is reserved for ports that
|
||||
currently do not compile, install, deinstall, or run correctly.
|
||||
It should be used for ports where the problem is believed
|
||||
to be temporary.</para>
|
||||
currently do not compile, install, deinstall, or run
|
||||
correctly. It should be used for ports where the problem
|
||||
is believed to be temporary.</para>
|
||||
|
||||
<para>If instructed, the build cluster will still attempt
|
||||
to try to build them to see if the underlying problem has
|
||||
|
|
|
@ -21,9 +21,10 @@
|
|||
|
||||
<note>
|
||||
<para>The following steps assume that the software compiled
|
||||
out-of-the-box. In other words, absolutely no changes were required
|
||||
for the application to work on a &os; system. If anything had to be
|
||||
changed, refer to <xref linkend="slow-porting"/>.</para>
|
||||
out-of-the-box. In other words, absolutely no changes were
|
||||
required for the application to work on a &os; system. If
|
||||
anything had to be changed, refer to <xref
|
||||
linkend="slow-porting"/>.</para>
|
||||
</note>
|
||||
|
||||
<note>
|
||||
|
@ -208,8 +209,8 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
|
|||
</note>
|
||||
|
||||
<para>The price for this way of listing a port's files and
|
||||
directories is that then command sequences
|
||||
described in &man.pkg-create.8; cannot be used. Therefore, it is suitable
|
||||
directories is that then command sequences described in
|
||||
&man.pkg-create.8; cannot be used. Therefore, it is suitable
|
||||
only for simple ports and makes them even simpler. At the
|
||||
same time, it has the advantage of reducing the number of
|
||||
files in the ports collection. Please consider using this
|
||||
|
@ -294,7 +295,8 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
|
|||
</step>
|
||||
|
||||
<step>
|
||||
<para><command>pkg add <replaceable>package-filename</replaceable></command></para>
|
||||
<para><command>pkg add
|
||||
<replaceable>package-filename</replaceable></command></para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
|
|
|
@ -59,8 +59,8 @@
|
|||
<para>The <buildtarget>patch</buildtarget> target is run.
|
||||
First, any patches defined in <varname>PATCHFILES</varname>
|
||||
are applied. Second, if any patch files named
|
||||
<filename>patch-<replaceable>*</replaceable></filename> are found in
|
||||
<varname>PATCHDIR</varname> (defaults to the
|
||||
<filename>patch-<replaceable>*</replaceable></filename> are
|
||||
found in <varname>PATCHDIR</varname> (defaults to the
|
||||
<filename>files</filename> subdirectory), they are applied
|
||||
at this time in alphabetical order.</para>
|
||||
</step>
|
||||
|
@ -170,8 +170,8 @@
|
|||
|
||||
<para>Get the original sources (normally) as a compressed tarball
|
||||
(<filename>foo.tar.gz</filename> or
|
||||
<filename><replaceable>foo</replaceable>.tar.bz2</filename>) and copy it into
|
||||
<varname>DISTDIR</varname>. Always use
|
||||
<filename><replaceable>foo</replaceable>.tar.bz2</filename>) and
|
||||
copy it into <varname>DISTDIR</varname>. Always use
|
||||
<emphasis>mainstream</emphasis> sources when and where you
|
||||
can.</para>
|
||||
|
||||
|
@ -344,7 +344,7 @@
|
|||
<note>
|
||||
<para>Manual patch creation is usually not necessary.
|
||||
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>
|
||||
</note>
|
||||
|
||||
|
@ -369,8 +369,8 @@
|
|||
|
||||
<screen>&prompt.user; <userinput>diff -u -N <replaceable>newfile</replaceable>.orig <replaceable>newfile</replaceable> > patch-<replaceable>pathname-newfile</replaceable></userinput></screen>
|
||||
|
||||
<para>Do not add <literal>$FreeBSD$</literal> RCS strings in
|
||||
patches. When patches are added to the
|
||||
<para>Do not add <literal>$FreeBSD$</literal> RCS
|
||||
strings in patches. When patches are added to the
|
||||
<application>Subversion</application> repository with
|
||||
<command>svn add</command>, the
|
||||
<literal>fbsd:nokeywords</literal> property is set to
|
||||
|
|
|
@ -810,8 +810,9 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subproject</programlisting>
|
|||
libtool (search for a file named ltmain.sh) need to have
|
||||
<literal>USES=libtool</literal>. Also, if a port has
|
||||
<literal>USE_AUTOTOOLS=libtoolize</literal> it probably also
|
||||
needs <literal>USES=libtool</literal>. See the <link linkend="uses-libtool">USES=libtool</link>
|
||||
section in <xref linkend="uses"/> for more details.</para>
|
||||
needs <literal>USES=libtool</literal>. See the <link
|
||||
linkend="uses-libtool">USES=libtool</link> section in <xref
|
||||
linkend="uses"/> for more details.</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
|
@ -1342,9 +1343,10 @@ USE_XORG= x11 xpm</programlisting>
|
|||
<title>Updating Desktop Database</title>
|
||||
|
||||
<para>If a port has a MimeType entry in its
|
||||
<filename><replaceable>portname</replaceable>.desktop</filename>, the desktop database
|
||||
must be updated after install and deinstall. To do this,
|
||||
define <varname>USES</varname>= desktop-file-utils.</para>
|
||||
<filename><replaceable>portname</replaceable>.desktop</filename>,
|
||||
the desktop database must be updated after install and
|
||||
deinstall. To do this, define <varname>USES</varname>=
|
||||
desktop-file-utils.</para>
|
||||
</sect3>
|
||||
|
||||
<sect3 xml:id="desktop-entries-macro">
|
||||
|
@ -1352,9 +1354,10 @@ USE_XORG= x11 xpm</programlisting>
|
|||
<varname>DESKTOP_ENTRIES</varname> Macro</title>
|
||||
|
||||
<para>Desktop entries can be easily created for applications
|
||||
by using the <varname>DESKTOP_ENTRIES</varname> variable. A
|
||||
file named <filename><replaceable>name</replaceable>.desktop</filename> will be
|
||||
created, installed, and added to the
|
||||
by using the <varname>DESKTOP_ENTRIES</varname> variable. A
|
||||
file named
|
||||
<filename><replaceable>name</replaceable>.desktop</filename>
|
||||
will be created, installed, and added to the
|
||||
<filename>pkg-plist</filename> automatically. Syntax
|
||||
is:</para>
|
||||
|
||||
|
|
|
@ -987,13 +987,14 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssapi</programlisting>
|
|||
|
||||
<entry>(none), <literal>Z</literal>, <literal>bz2</literal>,
|
||||
<literal>bzip2</literal>, <literal>lzma</literal>,
|
||||
<literal>tbz</literal>, <literal>tgz</literal>, <literal>txz</literal>,
|
||||
<literal>xz</literal></entry>
|
||||
<literal>tbz</literal>, <literal>tgz</literal>,
|
||||
<literal>txz</literal>, <literal>xz</literal></entry>
|
||||
|
||||
<entry>Set <varname>EXTRACT_SUFX</varname> to
|
||||
<literal>.tar</literal>, <literal>.tar.Z</literal>,
|
||||
<literal>.tar.bz2</literal>, <literal>.tar.bz2</literal>, <literal>.tar.lzma</literal>,
|
||||
<literal>.tbz</literal>, <literal>.tgz</literal>, <literal>.txz</literal> or
|
||||
<literal>.tar.bz2</literal>, <literal>.tar.bz2</literal>,
|
||||
<literal>.tar.lzma</literal>, <literal>.tbz</literal>,
|
||||
<literal>.tgz</literal>, <literal>.txz</literal> or
|
||||
<literal>.tar.xz</literal> respectively.</entry>
|
||||
</row>
|
||||
|
||||
|
|
Loading…
Reference in a new issue