[GLib] GLib Installation Failure: Errors in gtkdoc Helper Script

[llama90]

Describe the bug, including details regarding any error messages, version, and platform.

When I executed the command sudo meson install -C c_glib.build for GLib, the following error occurred.

For reference, I have configured my local setup to reference the latest version of Arrow c++ build for building glib.

I am using an M1 MacBook.

error log

unknown:0: warning: Value descriptions for GArrowRankTiebreaker are missing in source code comment block.
./arrow-glib-unused.txt:1: warning: 3 unused declarations. They should be added to arrow-glib-sections.txt in the appropriate place.

ERROR: Error in gtkdoc helper script:

ERROR: ['/opt/homebrew/bin/gtkdoc-mkhtml', '--path=/Users/lama/workspace/arrow-latest/c_glib/doc/arrow-glib:/Users/lama/workspace/arrow-latest/c_glib.build/doc/arrow-glib', 'arrow-glib', '../arrow-glib-docs.xml'] failed with status 5
I/O error : Attempt to load network entity http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
warning: failed to load external entity "http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
compilation error: file /opt/homebrew/Cellar/gtk-doc/1.33.2_1/share/gtk-doc/data/gtk-doc.xsl line 11 element import
xsl:import : unable to load http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl


--- stderr ---

FAILED: install script '/opt/homebrew/bin/meson --internal gtkdoc --sourcedir=/Users/lama/workspace/arrow-latest/c_glib --builddir=/Users/lama/workspace/arrow-latest/c_glib.build --subdir=doc/arrow-glib --headerdirs=/Users/lama/workspace/arrow-latest/c_glib/arrow-glib@@/Users/lama/workspace/arrow-latest/c_glib.build/arrow-glib --mainfile=arrow-glib-docs.xml --modulename=arrow-glib --moduleversion= --mode=auto --gtkdoc-scan=/opt/homebrew/bin/gtkdoc-scan --gtkdoc-scangobj=/opt/homebrew/bin/gtkdoc-scangobj --gtkdoc-mkdb=/opt/homebrew/bin/gtkdoc-mkdb --gtkdoc-mkhtml=/opt/homebrew/bin/gtkdoc-mkhtml --gtkdoc-fixxref=/opt/homebrew/bin/gtkdoc-fixxref --htmlargs= --scanargs=--rebuild-types@@--deprecated-guards=GARROW_DISABLE_DEPRECATED --scanobjsargs= --gobjects-types-file=/Users/lama/workspace/arrow-latest/c_glib/doc/arrow-glib/arrow-glib.types --fixxrefargs=--html-dir=/opt/homebrew/share/gtk-doc/html/arrow-glib@@--extra-dir=/opt/homebrew/Cellar/glib/2.78.3/share/gtk-doc/html/glib@@--extra-dir=/opt/homebrew/Cellar/glib/2.78.3/share/gtk-doc/html/gobject --mkdbargs=--output-format=xml@@--name-space=garrow@@--source-suffixes=c,cpp,h --html-assets= --content-files= --expand-content-files= --ignore-headers=/Users/lama/workspace/arrow-latest/c_glib/arrow-glib/gobject-type.h --installdir= --cc=ccache cc --ld=cc --cflags=-I/Users/lama/workspace/arrow-latest/c_glib/. -I/Users/lama/workspace/arrow-latest/c_glib.build/. -I/Users/lama/workspace/arrow-latest/cpp/cmake-build-debug/src -I/Users/lama/workspace/arrow-latest/c_glib/../cpp/src -I/Users/lama/workspace/arrow-latest/c_glib.build/../cpp/src -I/opt/homebrew/Cellar/glib/2.78.3/include -I/opt/homebrew/Cellar/glib/2.78.3/include/glib-2.0 -I/opt/homebrew/Cellar/glib/2.78.3/lib/glib-2.0/include -I/opt/homebrew/opt/gettext/include -I/opt/homebrew/Cellar/pcre2/10.42/include -I/Library/Developer/CommandLineTools/SDKs/MacOSX13.sdk/usr/include/ffi --ldflags=-L/Users/lama/workspace/arrow-latest/c_glib.build/arrow-glib -Wl,-rpath,/Users/lama/workspace/arrow-latest/c_glib.build/arrow-glib -L/Users/lama/workspace/arrow-latest/cpp/cmake-build-debug/debug -Wl,-rpath,/Users/lama/workspace/arrow-latest/cpp/cmake-build-debug/debug -L/opt/homebrew/Cellar/glib/2.78.3/lib -Wl,-rpath,/opt/homebrew/Cellar/glib/2.78.3/lib -L/opt/homebrew/opt/gettext/lib -Wl,-rpath,/opt/homebrew/opt/gettext/lib -larrow-glib /Users/lama/workspace/arrow-latest/cpp/cmake-build-debug/debug/libarrow.dylib /Users/lama/workspace/arrow-latest/cpp/cmake-build-debug/debug/libarrow_acero.dylib -L/opt/homebrew/Cellar/glib/2.78.3/lib -L/opt/homebrew/opt/gettext/lib -lgobject-2.0 -lglib-2.0 -lintl /opt/homebrew/Cellar/glib/2.78.3/lib/libgio-2.0.dylib' exit code 1, stopped

Component(s)

GLib

[kou]

Could you check whether you define XML_CATALOG_FILES=$(brew --prefix)/etc/xml/catalog or not?

See also: https://github.com/apache/arrow/tree/main/c_glib#how-to-build-by-developers ("macOS:" part)

[llama90]

The XML_CATALOG_FILES environment variable is set as follows.

echo $XML_CATALOG_FILES
/opt/homebrew/etc/xml/catalog

I have a suspicion that when attempting to access the chunk.xsl (http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl) file, trying to download it via a browser like Chrome results in a "Blocked Insecure download" message.

Is there a way to change the download from HTTP to HTTPS? Receiving it over HTTPS does not trigger a warning message.

[kou]

Hmm. If we use $(brew --prefix)/etc/xml/catalog, we don't need to download any files...
Does /opt/homebrew/etc/xml/catalog exist?

It seems that we should migrate our documentation tool to gi-docgen...

[llama90]

Aha... The /opt/homebrew/etc/xml/catalog is exist.

ls /opt/homebrew/etc/xml/catalog
/opt/homebrew/etc/xml/catalog

cat /opt/homebrew/etc/xml/catalog
<?xml version="1.0"?>
<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">
<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/4.2/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/4.1.2/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/4.3/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/4.4/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/4.5/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/5.0/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook/docbook/xml/5.1/catalog.xml"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl/catalog.xml"/>
  <rewriteSystem systemIdStartString="https://cdn.docbook.org/release/xsl-nons/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteURI uriStartString="https://cdn.docbook.org/release/xsl-nons/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteSystem systemIdStartString="https://cdn.docbook.org/release/xsl-nons/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteURI uriStartString="https://cdn.docbook.org/release/xsl-nons/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteSystem systemIdStartString="http://docbook.sourceforge.net/release/xsl/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteSystem systemIdStartString="http://docbook.sourceforge.net/release/xsl/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl"/>
  <nextCatalog catalog="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns/catalog.xml"/>
  <rewriteSystem systemIdStartString="https://cdn.docbook.org/release/xsl/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteURI uriStartString="https://cdn.docbook.org/release/xsl/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteSystem systemIdStartString="https://cdn.docbook.org/release/xsl/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteURI uriStartString="https://cdn.docbook.org/release/xsl/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteSystem systemIdStartString="http://docbook.sourceforge.net/release/xsl-ns/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl-ns/1.79.2" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteSystem systemIdStartString="http://docbook.sourceforge.net/release/xsl-ns/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
  <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl-ns/current" rewritePrefix="file:///opt/homebrew/opt/docbook-xsl/docbook-xsl-ns"/>
</catalog>

[kou]

Issue resolved by pull request 40427
#40427

[llama90]

@kou Thank you for letting me know.