GNOME Bugzilla – Bug 450343
gtk-doc gtk-doc.make install doesn't care about ENABLE_GTK_DOC
Last modified: 2018-05-22 13:01:38 UTC
Please describe the problem: If you are installing from release tarballs they can come with generated gtk-doc documentation: etelgeuse@pena /var/tmp/portage/x11-libs/libnotify-0.4.4/work/libnotify-0.4.4 $ find docs/reference/html/ docs/reference/html/ docs/reference/html/libnotify.devhelp docs/reference/html/style.css docs/reference/html/ch01.html docs/reference/html/right.png docs/reference/html/left.png docs/reference/html/index.html docs/reference/html/index.sgml docs/reference/html/home.png docs/reference/html/libnotify-notify.html docs/reference/html/libnotify.devhelp2 docs/reference/html/NotifyNotification.html docs/reference/html/up.png This means that even if you use ./configure --disable-gtk-doc they get installed Steps to reproduce: 1. download 2. libnotify-0.4.4 3. install using ./configure --disable-gtk-doc Actual results: Expected results: To not have tons of cruft in /usr/share/gtk-doc/html/ betelgeuse@pena /var/tmp/portage/x11-libs/libnotify-0.4.4/work/libnotify-0.4.4 $ du -sh /usr/share/gtk-doc/html/ 51M /usr/share/gtk-doc/html/ Does this happen every time? yes Other information: patch follows
Created attachment 90519 [details] [review] gtk-doc.make.patch
While there is certainly a case for not installing the documentation, I don't think changing the meaning of --disable-gtk-doc is the way to go. It has been always used to disable the rebuild rules, because rebuilding the documentation (typically with a result identical to the distributed version) is what one does not want to waste resources on. And it should retain this meaning as one often wants to install the documentation even if he does not want to rebuild it. Add a new option? Or --enable/disable-gtk-doc=SOMETHING?
Petteri, make install will also install header files, which is useless cruft if you don't plan to compile your own software :) I also agree, that we don't want to change the current behavior. The bug is quite old and seem to not received a lot of me-too. Do you still think there should be a means to disable installing the api-docs? If so what about a new flag?
*** Bug 773409 has been marked as a duplicate of this bug. ***
please confirm this patch for many gnome program. what allow distro-maintainer or user to care about this.. and save my disk space
Well the patch as such is almost okay, we probably also want to override the uninstall target. It is just that distributions solve this by packaging docs and dev files separately. Let me update the patch and push it.
Hit send too quickly ... I meant update the patch, not push. Also wrt. to comment #2, the flag is documented as "use gtk-doc to build documentation". We'd need to either extend the flag or add a new one 1) extend --enable/disable-gtk-doc={auto, build, install} which imho is weird and hard to understand. 2) new flag --enable/disable-gtk-doc-install For the default setting, lets consider: a) Using --enable-gtk-doc --disable-gtk-doc-install, seems to be less useful. b) Using --enable-gtk-doc only, one would expect --enable-gtk-doc-install as a default as this is the current behavior. So we'd definitely need to go for --enable-gtk-doc-install as the default. If this makes sense, we need an updated patch, that add this new option to gtk-doc.m4 and updated gtk-doc.make and gtk-doc.notmpl.make.
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk-doc/issues/6.