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

Recover lost <replaceable> tags.

Browse source
This commit is contained in:
Warren Block 2014-04-13 02:42:54 +00:00
parent 331e30e001
commit d0383f902f
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=44545
8 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -12,7 +12,7 @@
<title>The <filename>pkg-*</filename> Files</title>
<para>There are some tricks we have not mentioned yet about the
<filename>pkg-*</filename> files that come in handy
<filename>pkg-<replaceable>*</replaceable></filename> files that come in handy
sometimes.</para>
<sect1 xml:id="porting-message">
@ -84,16 +84,16 @@
<sect1 xml:id="pkg-names">
<title xml:id="porting-pkgfiles">Changing the Names of
<filename>pkg-*</filename> Files</title>
<filename>pkg-<replaceable>*</replaceable></filename> Files</title>
<para>All the names of <filename>pkg-*</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-*</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-*</filename>
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.

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

@ -28,15 +28,15 @@
<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>%%VARS%%</literal> related to port's
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>VAR=VALUE</literal> pairs and instances of
<literal>%%VAR%%</literal> will be substituted with
<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>
@ -97,7 +97,7 @@ 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>%%VAR%%</literal> substitution as described above.
<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
@ -190,7 +190,7 @@ lib/X11/oneko/sounds/cat.au
out.</para>
<para>Instead, install sample file(s) with a
<filename>filename.sample</filename> suffix. Then copy the
<filename><replaceable>filename</replaceable>.sample</filename> suffix. Then copy the
sample file to the real configuration file name, if it does not
already exist. On deinstall delete the configuration file, but
only if it is identical to the <filename>.sample</filename>
@ -291,7 +291,7 @@ etc/orbit.conf.sample
can get it wrong.</para>
<para>User configuration files should be installed as
<filename>filename.sample</filename>, as it is described in
<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

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

@ -36,7 +36,7 @@
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-*</filename> files, do so by
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>
@ -48,9 +48,9 @@
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/subdir/name/work</filename> not
<filename>PORTSDIR/subdir/name/work</filename> or
<filename>.CURDIR/../../subdir/name/work</filename> or some
<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>

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

@ -302,7 +302,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
</step>
<step>
<para><command>pkg add package-filename</command></para>
<para><command>pkg add <replaceable>package-filename</replaceable></command></para>
</step>
<step>

2
en_US.ISO8859-1/books/porters-handbook/security/chapter.xml
View file

@ -469,7 +469,7 @@
section of your entry will match correct package(s), issue the
following command:</para>
<screen>&prompt.user; <userinput>portaudit -f /usr/ports/INDEX -r uuid</userinput></screen>
<screen>&prompt.user; <userinput>portaudit -f /usr/ports/INDEX -r <replaceable>uuid</replaceable></userinput></screen>
<note>
<para>Please refer to &man.portaudit.1; for better

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

@ -59,7 +59,7 @@
<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-*</filename> are found in
<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>
@ -170,7 +170,7 @@
<para>Get the original sources (normally) as a compressed tarball
(<filename>foo.tar.gz</filename> or
<filename>foo.tar.bz2</filename>) and copy it into
<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>

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

@ -1217,7 +1217,7 @@ USE_XORG= x11 xpm</programlisting>
<title>Updating Desktop Database</title>
<para>If a port has a MimeType entry in its
<filename>portname.desktop</filename>, the desktop database
<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>
@ -1228,7 +1228,7 @@ USE_XORG= x11 xpm</programlisting>
<para>Desktop entries can be easily created for applications
by using the <varname>DESKTOP_ENTRIES</varname> variable. A
file named <filename>name.desktop</filename> will be
file named <filename><replaceable>name</replaceable>.desktop</filename> will be
created, installed, and added to the
<filename>pkg-plist</filename> automatically. Syntax
is:</para>
@ -2428,7 +2428,7 @@ do-install:
<title>Web Applications</title>
<para>Web applications should be installed into
<filename>PREFIX/www/appname</filename>.
<filename>PREFIX/www/<replaceable>appname</replaceable></filename>.
For your convenience, this path is available both in
<filename>Makefile</filename> and in
<filename>pkg-plist</filename> as <varname>WWWDIR</varname>,
@ -4748,7 +4748,7 @@ run_rc_command "$1"</programlisting>
<varname>SUB_LIST</varname> and using
<literal>%%PERL%%</literal>. Otherwise,</para>
<screen>&prompt.root; <userinput>service name stop</userinput></screen>
<screen>&prompt.root; <userinput>service <replaceable>name</replaceable> stop</userinput></screen>
<para>will probably not work properly. See
&man.service.8; for more information.</para>

2
en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml
View file

@ -153,7 +153,7 @@
committer.</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"/>
&prompt.user; <userinput>svn co <replaceable>https://svn0.us-west.FreeBSD.org</replaceable>/ports/head/dns/pdnsd</userinput> <co xml:id="svn-FreeBSD-org"/>
&prompt.user; <userinput>cd ~/my_wrkdir/pdnsd</userinput></screen>
<calloutlist>