[blfs-book] r21976 - trunk/BOOK/template

[pierre--- via blfs-book]

Author: pierre
Date: Fri Aug 16 04:52:56 2019
New Revision: 21976

Log:
Document the use of the new remap attributes in the template. Please feel
free to comment

Modified:
   trunk/BOOK/template/template.xml

Modified: trunk/BOOK/template/template.xml
==============================================================================
--- trunk/BOOK/template/template.xml    Thu Aug 15 21:27:26 2019        (r21975)
+++ trunk/BOOK/template/template.xml    Fri Aug 16 04:52:56 2019        (r21976)
@@ -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 @@
       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 @@
 <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>
-- 
http://lists.linuxfromscratch.org/listinfo/blfs-book
FAQ: http://www.linuxfromscratch.org/blfs/faq.html
Unsubscribe: See the above information page