Changeset 67e2e7f for gnome/platform

Timestamp:

07/11/2023 10:22:15 AM (11 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

12.0, 12.1, ken/TL2024, ken/tuningfonts, lazarus, plabs/newcss, python3.11, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

44723bf9

Parents:

d614533a

git-author:

Xi Ruoyao <xry111@…> (07/11/2023 10:20:26 AM)

git-committer:

Xi Ruoyao <xry111@…> (07/11/2023 10:22:15 AM)

Message:

libshumate: Remove reference to gtk-doc, and add instruction for gi-doc

gtk-doc is checked but never used.

File:

• gnome/platform/libshumate.xml (modified) (4 diffs)

gnome/platform/libshumate.xml

@@ -76 +76 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
-      <xref linkend="gi-docgen"/> and
-      <xref linkend="gtk-doc"/>
+      <xref linkend="gi-docgen"/>
+      <!-- and <xref linkend="gtk-doc"/> check but never used -->
     </para>
 
@@ -100 +100 @@
 
     <para>
+      If you have <xref linkend='gi-docgen'/> installed and wish to build
+      the API documentation for this package, issue:
+    </para>
+
+<screen remap='doc'><userinput>sed 's/lib_version/version/' -i ../docs/meson.build &amp;&amp;
+meson configure -Dgtk_doc=true                      &amp;&amp;
+ninja</userinput></screen>
+
+    <para>
       To test the results, issue: <command>ninja test</command>.
     </para>
@@ -115 +124 @@
     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
       href="../../xincludes/meson-buildtype-release.xml"/>
-
-    <para>
-      <parameter>-Dgtk_doc=false</parameter>: This switch disables documentation
-      generation. Remove this if you have both <xref linkend="gtk-doc"/> and
-      <xref linkend="gi-docgen"/> installed and wish to generate the API
-      documentation.
-    </para>
   </sect2>
 
@@ -140 +142 @@
         </seg>
         <seg>
-          /usr/include/shumate-1.0
+          /usr/include/shumate-1.0 and
+          /usr/share/doc/libshumate-&libshumate-version; (optional)
         </seg>
       </seglistitem>