Changeset e7d893b for general/genutils/gtk-doc.xml

Timestamp:

05/19/2019 04:54:33 AM (5 years ago)

Author:

DJ Lucas <dj@…>

Branches:

elogind

Children:

215c728b

Parents:

853ae3e5

Message:

Merge to HEAD 21602.

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

File:

• general/genutils/gtk-doc.xml (modified) (5 diffs)

general/genutils/gtk-doc.xml

@@ -7 +7 @@
   <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
   <!ENTITY gtk-doc-download-ftp  "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.xz">
-  <!ENTITY gtk-doc-md5sum        "df26a38c209b3d7358f26268fcbdb9e3">
-  <!ENTITY gtk-doc-size          "716 KB">
-  <!ENTITY gtk-doc-buildsize     "14 MB (with tests)">
+  <!ENTITY gtk-doc-md5sum        "1045ba29ca0693ced2045523407aae4c">
+  <!ENTITY gtk-doc-size          "740 KB">
+  <!ENTITY gtk-doc-buildsize     "17 MB (with tests)">
   <!ENTITY gtk-doc-time          "0.2 SBU (with tests)">
 ]>
@@ -65 +65 @@
     <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
 
+    <bridgehead renderas="sect4">Recommended</bridgehead>
+    <para role="recommended">
+      <xref role="runtime" linkend="pygments"/> at run time
+    </para>
+
     <bridgehead renderas="sect4">Required</bridgehead>
     <para role="required">
@@ -73 +78 @@
     </para>
 
-    <bridgehead renderas="sect4">Recommended</bridgehead>
-    <para role="recommended">
-      <xref linkend="highlight"/>
+    <bridgehead renderas="sect4">Optional</bridgehead>
+    <para role="optional">
+      For tests: 
+      <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
+      <xref linkend="fop"/> (XML PDF support),
+      <xref linkend="glib2"/>,
+      <xref linkend="which"/>, and
+      Python modules 
+      <ulink url="https://anytree.readthedocs.io/en/latest/">anytree</ulink>, and
+      <ulink url="https://pypi.org/project/parameterized/">paramerterized</ulink>
     </para>
 
-    <bridgehead renderas="sect4">Optional</bridgehead>
-    <para role="optional">
-      <ulink url="http://sourceforge.net/projects/dblatex/">dblatex</ulink> or
-      <xref linkend="fop"/> (XML PDF support),
-      <xref linkend="glib2"/> (for the test suite),
-      <ulink url="&gnome-download-http;/gnome-doc-utils/">GNOME Doc Utils</ulink> and
-      <xref linkend="which"/> (required for the test suite and gtk-doc documentation)
-    </para>
+    <note><para>The optional python modules above can be easily installed with
+    the <command>pip3</command> command.</para></note>
 
     <para condition="html" role="usernotes">User Notes:
@@ -101 +107 @@
 make</userinput></screen>
 
-    <para>To test the results, issue: <command>make check</command>. On some systems, the tests
-    may either hang indefinitely or fail.</para> 
+    <para>To test the results, issue: <command>make check</command>. 
+    Some tests will fail depending on optionally installed packages.</para> 
 
     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
@@ -119 +125 @@
 
       <seglistitem>
-        <seg>gtkdocize,
-        gtkdoc-check,  
-        gtkdoc-depscan, 
-        gtkdoc-fixxref,
-        gtkdoc-mkdb,   
-        gtkdoc-mkhtml,  
-        gtkdoc-mkman,        
-        gtkdoc-mkpdf,
-        gtkdoc-rebase, 
-        gtkdoc-scan, and 
-        gtkdoc-scangobj</seg>
+        <seg>
+          gtkdocize,
+          gtkdoc-check,  
+          gtkdoc-depscan, 
+          gtkdoc-fixxref,
+          gtkdoc-mkdb,   
+          gtkdoc-mkhtml,  
+          gtkdoc-mkhtml2,  
+          gtkdoc-mkman,        
+          gtkdoc-mkpdf,
+          gtkdoc-rebase, 
+          gtkdoc-scan, and 
+          gtkdoc-scangobj
+        </seg>
         
         <seg>None</seg>
         
-        <seg>/usr/lib/cmake/GtkDoc, 
-        /usr/share/gtk-doc, and
-        /usr/share/help/*/gtk-doc-manual
+        <seg>
+          /usr/share/gtk-doc and
+          /usr/share/help/*/gtk-doc-manual
         </seg>
       </seglistitem>