Document the use of the new remap attributes in the template. Please feel

free to comment

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21976 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Pierre Labastie 2019-08-16 11:52:56 +00:00
parent ce80f454ee
commit 76b2b9e356

View File

@ -198,7 +198,23 @@
<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>
<!-- Optional section. Use one of the two mentions below about a test
<!-- Optional paragraph. Add it when some instructions for building
documentation need optional or external packages. The remap="doc"
attribute signals those kind of instructions. Note: instructions
for generating documentation that can be built with
recommended/required/LFS book packages may be included in the
same block as configure and make. -->
<para>
If you have installed <xref linkend="optional-dep"/>, you can build
the documentation (or additional formats of the documentation) by issuing: </para>
<screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
<!-- adjust the instructions as needed. -->
<!-- Optional paragraph. Use one of the two mentions below about a test
suite, delete the line that is not applicable. Of course, if the
test suite uses syntax other than 'make check', revise the
line to reflect the actual syntax to run the test suite -->
@ -211,6 +227,23 @@ make</userinput></screen>
To test the results, issue: <command>make check</command>.
</para>
<!-- Sometimes, more complex instructions are needed for running tests, or
they need to be run as root. They can then be put inside screen
tags using the remap="test" attribute as in the following example: -->
<para>
If you want to run the tests, first create some needed files:
</para>
<screen remap="test"><userinput>make prepare-tests</userinput></screen>
<para>
Then run the tests as the <systemitem class="username">root</systemitem>
user:
</para>
<screen role="root" remap="test"><userinput>make tests</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
@ -218,6 +251,18 @@ make</userinput></screen>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<!-- Optional paragraph for documentation that has been generated using
optiona/external packages: -->
<para>
If you have built the optional documentation, install it as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"
remap="doc"><userinput>install -vdm 755 /usr/share/doc/template-&template-version; &amp;&amp;
mv doc/* /usr/share/doc/template-&template-version;</userinput></screen>
<!--Optional section-->
<sect2 role="commands">
<title>Command Explanations</title>