Changeset 3a7d81ba for gnome/platform/gcr4.xml

Timestamp:

02/14/2023 04:21:13 PM (15 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal

Children:

b266534e

Parents:

e6bb6b7f

git-author:

Xi Ruoyao <xry111@…> (02/14/2023 03:58:43 PM)

git-committer:

Xi Ruoyao <xry111@…> (02/14/2023 04:21:13 PM)

Message:

gcr (3 and 4): Make doc generation explicit

File:

• gnome/platform/gcr4.xml (modified) (2 diffs)

gnome/platform/gcr4.xml

@@ -120 +120 @@
 
     <para>
+      If you have <xref linkend='gi-docgen'/> installed and wish to build
+      the API documentation for this package, issue:
+    </para>
+
+<screen role='nodump'><userinput>sed -e "/install_dir/s@,\$@ / 'gcr-&gcr4-version;'&amp;@" \
+    -e "/fatal-warnings/d"                   \
+    -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>.
       The tests must be run from an X Terminal or similar.
@@ -145 +156 @@
 
     <para>
-      <option>-Dgtk_doc=true</option>: Use this switch if you wish
-      to generate the API reference documentation. Note that you must
-      have <xref linkend='gi-docgen'/> installed, and use the following
-      command to fix an issue in the build system before running
-      <command>cd build</command>:
-    </para>
-
-<screen role='nodump'><userinput>sed -e "/install_dir/s@,\$@ / 'gcr-&gcr4-version;'&amp;@" \
-    -e "/fatal-warnings/d" -i docs/*/meson.build</userinput></screen>
+      <option>-Dgtk_doc=true</option>: &gi-doc-disable;
+    </para>
 
     <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"