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

13.7 Making use of SUB_FILES and SUB_LIST

Browse source 
- Overhaul the section, make it easier to read
- Fix misleading example and provide a new example how file ready for
  substitution should look like

Reviewed by:	subdue (english)
Approved by:	remko
This commit is contained in:
Pav Lucistnik 2005-07-15 17:03:44 +00:00
parent ab6caf669d
commit a397d839a5
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=25128
1 changed files with 36 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
en_US.ISO8859-1/books/porters-handbook/book.sgml
View file

@ -5511,57 +5511,55 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
<title>Making use of <makevar>SUB_FILES</makevar> and
<makevar>SUB_LIST</makevar></title>
<para>In some cases, it may be necessary to modify port files,
i.e.: files not included in the original distribution, to set
values; the <makevar>SUB_FILES</makevar> and
<makevar>SUB_LIST</makevar> variables are available.</para>
<para>The <makevar>SUB_FILES</makevar> and <makevar>SUB_LIST</makevar>
variables are useful for dynamic values in port files, such as the
installation <makevar>PREFIX</makevar> in
<filename>pkg-message</filename>.</para>
<para>The <makevar>SUB_FILES</makevar> variable specifies a list
of files to be automatically modified. Each
<replaceable>file</replaceable> in the
<makevar>SUB_FILES</makevar> list must have a corresponding
<filename><replaceable>file</replaceable>.in</filename> listed
in <makevar>FILESDIR</makevar>. If you add some files, such as
<filename>pkg-message</filename>, <filename>pkg-install</filename>,
<filename>pkg-deinstall</filename> or <filename>pkg-reg</filename>,
<makevar>PKG-<replaceable>FILE</replaceable></makevar> associated
variables will be set to
<filename><makevar>WRKDIR</makevar>/pkg-<replaceable>file</replaceable></filename>.</para>
<filename><replaceable>file</replaceable>.in</filename> present
in <makevar>FILESDIR</makevar>. A modified version will
be created in <makevar>WRKDIR</makevar>. Files defined as a
value of <makevar>USE_RC_SUBR</makevar> and
<makevar>USE_RCORDER</makevar> are automatically added to
<makevar>SUB_FILES</makevar>. For the files
<filename>pkg-message</filename>,
<filename>pkg-install</filename>, <filename>pkg-deinstall</filename>
and <filename>pkg-reg</filename>, the corresponding Makefile variable
is automatically set to point to the processed version.</para>
<para>The <makevar>SUB_LIST</makevar> variable is a list of
<literal>VAR=VALUE</literal> pairs. The modified version of
each file will be created in
<makevar>WRKDIR</makevar>. For each
<literal>VAR=VALUE</literal> in <makevar>SUB_LIST</makevar>,
<literal>VAR=VALUE</literal> pairs. For each pair
<literal>%%VAR%%</literal> will get replaced
with <literal>VALUE</literal> in each file listed in
<makevar>SUB_FILES</makevar>. Some usual pairs are
automatically added to <makevar>SUB_LIST</makevar>,
so you are not required to worry about them :
<literal>PREFIX=&dollar;{PREFIX}DOCSDIR=&dollar;{DOCSDIR}</literal>,
etc. (see <filename>bsd.port.mk</filename> for the entire
list).</para>
<para> The substitution process is almost the same as the
<makevar>PLIST_SUB</makevar> variable. Any line beginning with
<literal>@comment</literal> after variable substitution will be
deleted from resulting files.</para>
<para>The following example should be enough for a port to
display a custom <filename>pkg-message</filename>,
using <literal>%%PREFIX%%</literal>,
and to install an rcNG startup script using
<literal>%%RC_SUBR%%</literal>.</para>
<programlisting>SUB_FILES= pkg-message myport.sh
SUB_LIST= RC_SUBR=${RC_SUBR}
<makevar>SUB_FILES</makevar>. Several common pairs are
automatically defined: <makevar>PREFIX</makevar>,
<makevar>LOCALBASE</makevar>, <makevar>X11BASE</makevar>,
<makevar>DATADIR</makevar>, <makevar>DOCSDIR</makevar>,
<makevar>EXAMPLESDIR</makevar>. Any line beginning with
<literal>@comment</literal> will be deleted from resulting files
after a variable substitution.</para>
USE_RC_SUBR= yes</programlisting>
<para>The following example will replace <literal>%%ARCH%%</literal>
with the system architecture
in a <filename>pkg-message</filename>:</para>
<programlisting>SUB_FILES= pkg-message
SUB_LIST= ARCH=${ARCH}</programlisting>
<para>Note that for this example, the
<filename>pkg-message.in</filename> and
<filename>myport.sh.in</filename> files must exist in
<filename>pkg-message.in</filename> file must exist in
<makevar>FILESDIR</makevar>.</para>
<para>Example of a good <filename>pkg-message.in</filename>:</para>
<programlisting>Now it's time to configure this package.
Copy %%PREFIX%%/share/examples/putsy/%%ARCH%%.conf into your home directory
as .putsy.conf and edit it.</programlisting>
</sect1>
</chapter>