Ignore:
Timestamp:
03/18/2020 10:00:14 AM (4 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.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:
63228ac1
Parents:
dca1247
Message:

Format general/genutils

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • general/genutils/gtk-doc.xml

    rdca1247 rb7a85cd9  
    3030    <title>Introduction to GTK-Doc</title>
    3131
    32     <para>The <application>GTK-Doc</application> package
    33     contains a code documenter. This is useful for extracting specially formatted
    34     comments from the code to create API documentation. This
    35     package is <emphasis>optional</emphasis>; if it is not installed, packages will
    36     not build the documentation. This does not mean that you will not have any
    37     documentation. If <application>GTK-Doc</application> is not
    38     available, the install process will copy any pre-built documentation to your
    39     system.</para>
     32    <para>
     33      The <application>GTK-Doc</application> package contains a code
     34      documenter. This is useful for extracting specially formatted comments
     35      from the code to create API documentation. This package is
     36      <emphasis>optional</emphasis>; if it is not installed, packages will
     37      not build the documentation. This does not mean that you will not have
     38      any documentation. If <application>GTK-Doc</application> is not
     39      available, the install process will copy any pre-built documentation
     40      to your system.
     41    </para>
    4042
    4143    &lfs91_checked;
    … …  
    4446    <itemizedlist spacing="compact">
    4547      <listitem>
    46         <para>Download (HTTP): <ulink url="&gtk-doc-download-http;"/></para>
    47       </listitem>
    48       <listitem>
    49         <para>Download (FTP): <ulink url="&gtk-doc-download-ftp;"/></para>
    50       </listitem>
    51       <listitem>
    52         <para>Download MD5 sum: &gtk-doc-md5sum;</para>
    53       </listitem>
    54       <listitem>
    55         <para>Download size: &gtk-doc-size;</para>
    56       </listitem>
    57       <listitem>
    58         <para>Estimated disk space required: &gtk-doc-buildsize;</para>
    59       </listitem>
    60       <listitem>
    61         <para>Estimated build time: &gtk-doc-time;</para>
     48        <para>
     49          Download (HTTP): <ulink url="&gtk-doc-download-http;"/>
     50        </para>
     51      </listitem>
     52      <listitem>
     53        <para>
     54          Download (FTP): <ulink url="&gtk-doc-download-ftp;"/>
     55        </para>
     56      </listitem>
     57      <listitem>
     58        <para>
     59          Download MD5 sum: &gtk-doc-md5sum;
     60        </para>
     61      </listitem>
     62      <listitem>
     63        <para>
     64          Download size: &gtk-doc-size;
     65        </para>
     66      </listitem>
     67      <listitem>
     68        <para>
     69          Estimated disk space required: &gtk-doc-buildsize;
     70        </para>
     71      </listitem>
     72      <listitem>
     73        <para>
     74          Estimated build time: &gtk-doc-time;
     75        </para>
    6276      </listitem>
    6377    </itemizedlist>
    … …  
    91105    </para>
    92106
    93     <note><para>The optional python modules above can be easily installed with
    94     the <command>pip3</command> command.</para></note>
     107    <note>
     108      <para>
     109      The optional python modules above can be easily installed with
     110      the <command>pip3</command> command.
     111      </para>
     112    </note>
    95113
    96114    <para condition="html" role="usernotes">User Notes:
    … …  
    102120    <title>Installation of GTK-Doc</title>
    103121
    104     <para>Install <application>GTK-Doc</application> by running
    105     the following commands:</para>
     122    <para>
     123      Install <application>GTK-Doc</application> by running
     124      the following commands:
     125    </para>
    106126
    107127<screen><userinput>./configure --prefix=/usr &amp;&amp;
    108128make</userinput></screen>
    109129
    110     <para>The test suite will hang if the package (or a previous version)
    111     is not already installed.</para>
    112 
    113     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     130    <para>
     131      The test suite will hang if the package (or a previous version)
     132      is not already installed.
     133    </para>
     134
     135    <para>
     136      Now, as the <systemitem class="username">root</systemitem> user:
     137    </para>
    114138
    115139<screen role="root"><userinput>make install</userinput></screen>
    116140
    117     <para>To test the results, issue: <command>make check</command>.
    118     Some tests will fail depending on optionally installed packages.</para>
     141    <para>
     142      To test the results, issue: <command>make check</command>.
     143      Some tests will fail depending on optionally installed packages.
     144    </para>
    119145
    120146  </sect2>
    … …  
    161187        <term><command>gtkdoc*</command></term>
    162188        <listitem>
    163           <para>these are all shell, or         
    164           <application>Python</application> scripts used by
    165           package <filename>Makefile</filename> scripts to generate
    166           documentation for the package being built.</para>
     189          <para>
     190            these are all shell, or         
     191            <application>Python</application> scripts used by
     192            package <filename>Makefile</filename> scripts to generate
     193            documentation for the package being built.
     194          </para>
    167195          <indexterm zone="gtk-doc gtkdoc">
    168196            <primary sortas="b-gtkdoc*">gtkdoc*</primary>
Note: See TracChangeset for help on using the changeset viewer.