Changeset ca2b7962 for gnome/platform

Timestamp:

02/14/2023 01:07:32 PM (16 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:

1bc00bd8

Parents:

760d71b

Message:

vte: Make docdir fix and doc generation explicit

File:

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

gnome/platform/vte.xml

@@ -123 +123 @@
 
     <para>
+      If you have <xref linkend='gi-docgen'/> installed and wish to build
+      the API documentation for this package, issue:
+    </para>
+
+    <!-- To editors: you may wonder why this change makes a
+         /usr/share/doc/vte-&vte-version; with only one subdirectory
+         "vte-2.91" inside.  The reason is when -Dgtk4 is enabled,
+         another directory "vte-2.91-gtk4" will also be there.  -->
+<screen role='nodump'><userinput>sed -e "/docdir =/s@\$@/ 'vte-&vte-version;'@" \
+    -e "/fatal-warnings/d"              \
+    -i ../doc/reference/meson.build     &amp;&amp;
+meson configure -Ddocs=true             &amp;&amp;
+ninja</userinput></screen>
+
+    <para>
       To test the results, issue <command>ninja test</command>.
     </para>
@@ -159 +174 @@
       <option>-Dvapi=false</option>: Add this switch if you do not
       want to enable vala bindings.
-    </para>
-
-    <para>
-      <option>-Ddocs=true</option>: Add this switch if wish to
-      build the documentation.  It requires <xref linkend='gi-docgen'/>.
-      It's needed to use the
-      <command>sed '/fatal-warning/d' -i doc/reference/meson.build</command>
-      command before <command>mkdir build</command> to work around an issue
-      in the build system if this option will be used.  And, if this option
-      is used, after the installation use the
-      <command>mv /usr/share/doc/vte-{2.&vte-nano;,&vte-version;}</command>
-      as the &root; user to move the API documentation into the expected
-      location.
     </para>