Changeset a42c273 for general/prog


Ignore:
Timestamp:
05/21/2019 12:39:37 PM (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:
77deb22e
Parents:
1dbb694f
Message:

First round of remap attributes; the "doc" ones + a few "test". Rewrote some
parts so that doc that can be installed with recommended deps is in main
instructions. Also, move doc instructions in <command> tags to <screen>.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21613 af4574ff-66df-0310-9fd7-8a98e5e911e0

Location:
general/prog
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • general/prog/doxygen.xml

    r1dbb694f ra42c273  
    150150    </para>
    151151
    152 <screen><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &amp;&amp;
     152<screen remap="doc"><userinput>cmake -DDOC_INSTALL_DIR=share/doc/doxygen-&doxygen-version; -Dbuild_doc=ON .. &amp;&amp;
    153153
    154154make docs</userinput></screen>

  • general/prog/gdb.xml

    r1dbb694f ra42c273  
    120120    </para>
    121121
    122 <screen><userinput>make -C gdb/doc doxy</userinput></screen>
     122<screen remap="doc"><userinput>make -C gdb/doc doxy</userinput></screen>
    123123
    124124    <para>
    … …  
    126126    </para>
    127127
    128 <screen><userinput>pushd gdb/testsuite &amp;&amp;
     128<screen remap="test"><userinput>pushd gdb/testsuite &amp;&amp;
    129129make  site.exp      &amp;&amp;
    130130echo  "set gdb_test_timeout 120" &gt;&gt; site.exp &amp;&amp;
    … …  
    205205    </para>
    206206
    207 <screen role="root"><userinput>install -d /usr/share/doc/gdb-&gdb-version; &amp;&amp;
     207<screen role="root"
     208        remap="doc"><userinput>install -d /usr/share/doc/gdb-&gdb-version; &amp;&amp;
    208209rm -rf gdb/doc/doxy/xml &amp;&amp;
    209210cp -Rv gdb/doc/doxy /usr/share/doc/gdb-&gdb-version;</userinput></screen>

  • general/prog/git.xml

    r1dbb694f ra42c273  
    165165    </para>
    166166
    167 <screen><userinput>make html</userinput></screen>
     167<screen remap="doc"><userinput>make html</userinput></screen>
    168168
    169169    <para>
    … …  
    172172    </para>
    173173
    174 <screen><userinput>make man</userinput></screen>
     174<screen remap="doc"><userinput>make man</userinput></screen>
    175175
    176176    <para>
    … …  
    195195    </para>
    196196
    197 <screen role="root"><userinput>make install-man</userinput></screen>
     197<screen role="root" remap="doc"><userinput>make install-man</userinput></screen>
    198198
    199199    <para>
    … …  
    202202    </para>
    203203
    204 <screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
     204<screen role="root" remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
    205205
    206206<!-- ==== Method 2 for docs ====== -->

  • general/prog/llvm.xml

    r1dbb694f ra42c273  
    211211
    212212    <para>
     213      If you have installed <application>Sphinx</application> and
     214      <application>recommonmark</application> and wish
     215      to generate the html documentation and manual pages, issue the following
     216      commands:
     217    </para>
     218
     219<screen remap="doc"><userinput>cmake -DLLVM_ENABLE_SPHINX=ON         \
     220      -DSPHINX_WARNINGS_AS_ERRORS=OFF \
     221      -Wno-dev -G Ninja ..            &amp;&amp;
     222ninja docs-llvm-html  docs-llvm-man</userinput></screen>
     223
     224    <para>
     225      If you have downloaded the optional packages, the clang documentation
     226      can be built too:
     227    </para>
     228
     229<screen remap="doc"><userinput>ninja docs-clang-html docs-clang-man</userinput></screen>
     230
     231    <para>
    213232      <!-- EDITORS - if you have more than 4 cores, take some offline to measure
    214233      the elapsed time for the tests.  Also, libstdc++.a and perhaps libstdc++fs.a
    … …  
    234253
    235254    <para>
    236       If you have installed <application>Sphinx</application> and
    237       <application>recommonmark</application> and wish
    238       to generate the html documentation and manual pages, issue the following
    239       commands:
    240     </para>
    241 <screen><userinput>cmake -DLLVM_ENABLE_SPHINX=ON         \
    242       -DSPHINX_WARNINGS_AS_ERRORS=OFF \
    243       -Wno-dev -G Ninja ..            &amp;&amp;
    244 ninja docs-llvm-html  docs-llvm-man</userinput></screen>
    245     <para>
    246       If you have downloaded the optional packages, the clang documentation
    247       can be built too:
    248     </para>
    249 <screen><userinput>ninja docs-clang-html docs-clang-man</userinput></screen>
    250 
    251     <para>
    252       Install the llvm documentation by running the following command as the
    253       <systemitem class="username">root</systemitem> user:
    254     </para>
    255 
    256 <screen role="root"><userinput>install -v -m644 docs/man/* /usr/share/man/man1             &amp;&amp;
     255      If you have built the the llvm documentation, install it by running the
     256      following commands as the <systemitem class="username">root</systemitem>
     257      user:
     258    </para>
     259
     260<screen role="root"
     261        remap="doc"><userinput>install -v -m644 docs/man/* /usr/share/man/man1             &amp;&amp;
    257262install -v -d -m755 /usr/share/doc/llvm-&llvm-version;/llvm-html     &amp;&amp;
    258263cp -Rv docs/html/* /usr/share/doc/llvm-&llvm-version;/llvm-html</userinput></screen>
    259264
    260265    <para>
    261       The clang documentation can be installed in the same way (again as the
     266      If you have built the clang documentation, it can be installed in the
     267      same way (again as the
    262268      <systemitem class="username">root</systemitem> user):
    263269    </para>
    264270
    265 <screen role="root"><userinput>install -v -m644 tools/clang/docs/man/* /usr/share/man/man1 &amp;&amp;
     271<screen role="root"
     272        remap="doc"><userinput>install -v -m644 tools/clang/docs/man/* /usr/share/man/man1 &amp;&amp;
    266273install -v -d -m755 /usr/share/doc/llvm-&llvm-version;/clang-html    &amp;&amp;
    267274cp -Rv tools/clang/docs/html/* /usr/share/doc/llvm-&llvm-version;/clang-html</userinput></screen>

  • general/prog/mercurial.xml

    r1dbb694f ra42c273  
    100100    issue:</para>
    101101
    102 <screen><userinput>sed -i '/runrst/s/N)/N)3/' doc/Makefile &amp;&amp;
     102<screen remap="doc"><userinput>sed -i '/runrst/s/N)/N)3/' doc/Makefile &amp;&amp;
    1031032to3-3.7 -w doc/hgmanpage.py            &amp;&amp;
    104104make doc</userinput></screen>
    … …  
    111111    issue:</para>
    112112
    113 <screen><userinput>cat &gt; tests/blacklists/failed-tests &lt;&lt; "EOF"
     113<screen remap="test"><userinput>cat &gt; tests/blacklists/failed-tests &lt;&lt; "EOF"
    114114<literal># Test Failures
    115115  test-gpg.t</literal>
    … …  
    119119      To run the test suite, issue:
    120120    </para>
    121 <screen><userinput>rm -rf tests/tmp &amp;&amp;
     121<screen remap="test"><userinput>rm -rf tests/tmp &amp;&amp;
    122122TESTFLAGS="-j<replaceable>&lt;N&gt;</replaceable> --tmpdir tmp --blacklist blacklists/failed-tests" make check</userinput></screen>
    123123
    … …  
    130130    the tests that failed before:</para>
    131131
    132 <screen><userinput>pushd tests  &amp;&amp;
     132<screen remap="test"><userinput>pushd tests  &amp;&amp;
    133133  rm -rf tmp &amp;&amp;
    134134  ./run-tests.py --tmpdir tmp test-gpg.t
    … …  
    142142    or not. One test, test-https.t, is known to fail.</para>
    143143
    144     <para>An interesting switch is "- -time", which will generate at the end of
     144    <para>An interesting switch is "--time", which will generate at the end of
    145145    the test suite execution, a table with all executed tests and respective
    146146    start, end, user, system and real times. Notice that the switches may be
    … …  
    156156    command (as <systemitem class="username">root</systemitem>):</para>
    157157
    158 <screen role="root"><userinput>make PREFIX=/usr install-doc</userinput></screen>
     158<screen role="root"
     159        remap="doc"><userinput>make PREFIX=/usr install-doc</userinput></screen>
    159160
    160161    <para>After installed, two very quick and simple tests should run correctly.
Note: See TracChangeset for help on using the changeset viewer.