Changeset 76b2b9e for template/template.xml

Timestamp:

08/16/2019 11:52:56 AM (5 years ago)

Author:

Pierre Labastie <pieere@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 9.0, 9.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

c910aa5

Parents:

ce80f454

Message:

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

File:

• template/template.xml (modified) (3 diffs)

template/template.xml

@@ -199 +199 @@
 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
@@ -212 +228 @@
     </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:
@@ -218 +251 @@
 <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-->