Changeset 76b2b9e for template


Ignore:
Timestamp:
08/16/2019 11:52:56 AM (2 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 9.0, 9.1, qt5new, trunk, xry111/git-date, xry111/git-date-for-trunk, xry111/git-date-test
Children:
c910aa5
Parents:
ce80f45
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:
1 edited

Legend:

Unmodified
Added
Removed
  • template/template.xml

    rce80f45 r76b2b9e  
    199199make</userinput></screen>
    200200
    201     <!-- Optional section. Use one of the two mentions below about a test
     201    <!-- Optional paragraph. Add it when some instructions for building
     202         documentation need optional or external packages. The remap="doc"
     203         attribute signals those kind of instructions. Note: instructions
     204         for generating documentation that can be built with
     205         recommended/required/LFS book packages may be included in the
     206         same block as configure and make. -->
     207
     208    <para>
     209      If you have installed <xref linkend="optional-dep"/>, you can build
     210      the documentation (or additional formats of the documentation) by issuing:    </para>
     211
     212<screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
     213
     214    <!-- adjust the instructions as needed. -->
     215         
     216
     217    <!-- Optional paragraph. Use one of the two mentions below about a test
    202218         suite, delete the line that is not applicable. Of course, if the
    203219         test suite uses syntax other than 'make check', revise the
     
    212228    </para>
    213229
     230    <!-- Sometimes, more complex instructions are needed for running tests, or
     231         they need to be run as root. They can then be put inside screen
     232         tags using the remap="test" attribute as in the following example: -->
     233
     234    <para>
     235      If you want to run the tests, first create some needed files:
     236    </para>
     237
     238<screen remap="test"><userinput>make prepare-tests</userinput></screen>
     239
     240    <para>
     241      Then run the tests as the <systemitem class="username">root</systemitem>
     242      user:
     243    </para>
     244
     245<screen role="root" remap="test"><userinput>make tests</userinput></screen>
     246
    214247    <para>
    215248      Now, as the <systemitem class="username">root</systemitem> user:
     
    218251<screen role="root"><userinput>make install</userinput></screen>
    219252  </sect2>
     253
     254    <!-- Optional paragraph for documentation that has been generated using
     255         optiona/external packages: -->
     256
     257    <para>
     258      If you have built the optional documentation, install it as the
     259      <systemitem class="username">root</systemitem> user:
     260    </para>
     261
     262<screen role="root"
     263        remap="doc"><userinput>install -vdm 755 /usr/share/doc/template-&template-version; &amp;&amp;
     264mv doc/* /usr/share/doc/template-&template-version;</userinput></screen>
    220265
    221266  <!--Optional section-->
Note: See TracChangeset for help on using the changeset viewer.