libgusb: Make doc generation explicit

This commit is contained in:
Xi Ruoyao 2023-02-14 23:21:05 +08:00
parent 5dc3b4a645
commit e6bb6b7fae
No known key found for this signature in database
GPG Key ID: ACAAD20E19E710E3

View File

@ -107,6 +107,15 @@
cd build &&
meson --prefix=/usr --buildtype=release -Ddocs=false .. &&
ninja</userinput></screen>
<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 "/output: 'libgusb'/s/'\$/-0.4.5'/" -i ../docs/meson.build &amp;&amp;
meson configure -Ddocs=true &amp;&amp;
ninja</userinput></screen>
<para>
@ -127,16 +136,9 @@ ninja</userinput></screen>
href="../../xincludes/meson-buildtype-release.xml"/>
<para>
<parameter>-Ddocs=false</parameter>: building documentation needs
<xref linkend="gi-docgen"/>. Remove this switch if you have
installed <application>gi-docgen</application>, and you wish to build
the API documentation. If this option is used, use the following
command to fix the directory name of the API documentation after
this package is installed:
<parameter>-Ddocs=false</parameter>: &gi-doc-disable;
</para>
<screen role='nodump'><userinput>mv -v /usr/share/doc/libgusb{,-&libgusb-version;}</userinput></screen>
</sect2>
<sect2 role="content">