Re: nautilus-47.0 requires gi-docgen with docs enabled

On Tue, 2024-10-29 at 12:04 +0800, Zhang Wen wrote:
> 在 2024/10/29 11:51, Zhang Wen 写道:
> 
> > From nautilus's meson.build file, gi-docgen is required if the docs 
> > option is enabled.
> > 
> > So we may need to add gi-docgen as one of required dependency, or 
> > remove the "docs=true" option from the build instructions.
> > 
> I'm so sorry for the wrong package name in the title.
> 
> It is gi-docgen, not gi-docs.

The meson configure -D docs=true command is intended to be used with gi-
docgen installed.  Without gi-docgen you cannot generate and install the
API documentation.

And the text reads:

   If you wish to generate and install the API documentation, issue the
   following commands:
   
I.e. if you wish to generate the API documentation, you should have gi-
docgen installed (as it's listed optional for API documentation in the
dependency section).  If you don't wish to generate the API
documentation, you shouldn't issue the command at all.  To me it's quite
obvious but as you are complaining I'll make it more explicit.

The command block for generating the API documentation also lacks a
"ninja" command.  This should be "harmless" as the following "ninja
test" or "ninja install" commands will generate the doc anyway, but
ugly.

So I'll push the change:

diff --git a/gnome/platform/nautilus.xml b/gnome/platform/nautilus.xml
index 697aba8d01..b6959356b8 100644
--- a/gnome/platform/nautilus.xml
+++ b/gnome/platform/nautilus.xml
@@ -124,12 +124,14 @@ meson setup --prefix=/usr       \
 ninja</userinput></screen>
 
     <para>
-      If you wish to generate and install the API documentation, issue the
-      following commands:
+      If you have <xref linkend='gi-docgen'/> installed and you wish to
+      generate and install the API documentation, issue the following
+      commands:
     </para>
 
 <screen><userinput remap="doc">sed "/docdir =/s@\$@ / 'nautilus-&nautilus-version;'@" -i ../meson.build &amp;&amp;
-meson configure -D docs=true</userinput></screen>
+meson configure -D docs=true &amp;&amp;
+ninja</userinput></screen>
 
     <para>
       To test the results, issue: <command>ninja test</command>. The tests


-- 
Xi Ruoyao <[email protected]>
School of Aerospace Science and Technology, Xidian University

-- 
http://lists.linuxfromscratch.org/sympa/info/blfs-dev
Unsubscribe: See the above information page