After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 771359 - "make distcheck" fails when srcdir != builddir
"make distcheck" fails when srcdir != builddir
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2016-09-13 13:15 UTC by Bastien Nocera
Modified: 2018-05-04 14:09 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Bastien Nocera 2016-09-13 13:15:38 UTC
This is a problem with version 1.1 and 1.2 of iio-sensor-proxy, as well as the current master version:
https://github.com/hadess/iio-sensor-proxy/

Using gtkdocize (gtk-doc) 1.25.1

With srcdir != builddir, running "make dist" adds the following files in the docs/ subdirectory of the archive:
drwxr-xr-x 1000/1000         0 2016-09-13 14:23 iio-sensor-proxy-1.2/docs/
-rw-r--r-- 1000/1000      1402 2016-09-13 14:22 iio-sensor-proxy-1.2/docs/Makefile.am
-rw-r--r-- 1000/1000     29745 2016-09-13 14:23 iio-sensor-proxy-1.2/docs/Makefile.in
-rw-r--r-- 1000/1000        10 2015-05-19 23:15 iio-sensor-proxy-1.2/docs/version.xml.in
-rw-r--r-- 1000/1000      2542 2015-06-03 12:51 iio-sensor-proxy-1.2/docs/iio-sensor-proxy-docs.xml

"make distcheck" fails.

With srcdir = builddir, running "make distcheck" succeeds, and has the following files in the resulting archive:
drwxr-xr-x 1000/1000         0 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/
-rw-r--r-- 1000/1000      1372 2015-07-23 15:27 iio-sensor-proxy-1.2/docs/Makefile.am
drwxr-xr-x 1000/1000         0 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/
-rw-r--r-- 1000/1000       373 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/right-insensitive.png
-rw-r--r-- 1000/1000      1567 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/license.html
-rw-r--r-- 1000/1000       260 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/up.png
-rw-r--r-- 1000/1000       374 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/up-insensitive.png
-rw-r--r-- 1000/1000       395 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/left-insensitive.png
-rw-r--r-- 1000/1000      3422 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/index.html
-rw-r--r-- 1000/1000      8812 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/style.css
-rw-r--r-- 1000/1000      6066 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/gdbus-net.hadess.SensorProxy.Compass.html
-rw-r--r-- 1000/1000     10596 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/gdbus-net.hadess.SensorProxy.html
-rw-r--r-- 1000/1000       262 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/left.png
-rw-r--r-- 1000/1000      4776 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/ix01.html
-rw-r--r-- 1000/1000       261 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/right.png
-rw-r--r-- 1000/1000      2281 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/ref-dbus.html
-rw-r--r-- 1000/1000      2849 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/iio-sensor-proxy.devhelp2
-rw-r--r-- 1000/1000       256 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/html/home.png
-rw-r--r-- 1000/1000         0 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/iio-sensor-proxy.types
-rw-r--r-- 1000/1000         0 2015-05-19 23:49 iio-sensor-proxy-1.2/docs/iio-sensor-proxy-overrides.txt
-rw-r--r-- 1000/1000     29717 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/Makefile.in
-rw-r--r-- 1000/1000         0 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/iio-sensor-proxy-sections.txt
-rw-r--r-- 1000/1000         4 2016-09-06 15:16 iio-sensor-proxy-1.2/docs/version.xml
-rw-r--r-- 1000/1000      9604 2016-09-06 14:55 iio-sensor-proxy-1.2/docs/docs-net.hadess.SensorProxy.xml
-rw-r--r-- 1000/1000        10 2015-05-19 23:15 iio-sensor-proxy-1.2/docs/version.xml.in
-rw-r--r-- 1000/1000      2542 2015-06-03 12:51 iio-sensor-proxy-1.2/docs/iio-sensor-proxy-docs.xml

The Makefile.am for API docs is at:
https://github.com/hadess/iio-sensor-proxy/blob/master/docs/Makefile.am
Comment 1 Bastien Nocera 2016-09-13 13:24:12 UTC
You'll need to revert 5ff39aea7dfc0c63632281c32b2d4619b8ae6512 to test this though, as I made changes to avoid running into problems during the build.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2016-09-13 20:16:27 UTC
I can't configure your module for out-of-srcdir builds
I removed the check in autogen already (git reset --hard HEAD~1)

../configure: line 1854: syntax error near unexpected token `git-directory'
../configure: line 1854: `AX_IS_RELEASE(git-directory)'
Comment 3 Bastien Nocera 2016-09-13 22:25:51 UTC
(In reply to Stefan Sauer (gstreamer, gtkdoc dev) from comment #2)
> I can't configure your module for out-of-srcdir builds
> I removed the check in autogen already (git reset --hard HEAD~1)
> 
> ../configure: line 1854: syntax error near unexpected token `git-directory'
> ../configure: line 1854: `AX_IS_RELEASE(git-directory)'

https://www.gnu.org/software/autoconf-archive/ax_is_release.html

It's built into autoconf-archive-2016.03.20-1.fc25.noarch on my distribution.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2016-09-16 08:26:50 UTC
Seems, you have a newer snapshot:
autoconf-archive   20131101-1
find /usr/share/aclocal/ -name *.m4 -exec grep -Hn "AX_IS_RELEASE" {} \;
<nothing>

I'll try to build it on a VM, sigh.
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2018-03-23 21:26:10 UTC
There were some issues that I've fixed with:
commit 350fbc5adaf5f996287ce9bbdd6b73000de9a401
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Fri Mar 23 21:32:29 2018 +0100

    mkhtml/pdf: fix out-of-srcdir builds
    
    Fix how we assemble the --path param to xsltproc. We can only use --path once.
    If there are multipel path we can separate them with a colon.
    
    Also pass the search-path in dblatex through to xsltproc.
    
    Finally from reading the xslt-sources we found out that the searchpath works
    by appending only the filename part to each searchpath entry. Hence define
    a path for the gobject example so that the source-file includes work.

Not sure if it fixes these issues though.
Comment 6 Bastien Nocera 2018-05-04 14:09:04 UTC
That seems to work as expected with more recent versions of gtk-doc, thanks!