Bug 173577 - devel/devhelp doesn't recognize GTK+ reference documentation
Summary: devel/devhelp doesn't recognize GTK+ reference documentation
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: freebsd-gnome (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-11-12 13:00 UTC by Victor Balada Diaz
Modified: 2013-05-22 12:40 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Victor Balada Diaz 2012-11-12 13:00:00 UTC
devhelp doesn't recognize the documentation installed by ports like:

gtk-reference or glib-reference.

devhelp assumes that documentation is installed at /usr/local/share/gtk-doc/html
x11-toolkits/gtk20-reference installs documentation at: /usr/local/share/doc/gtk/
devel/glib20-reference installs documentation at: /usr/local/share/doc/glib/

Fix: 

An easy fix would be to change installation path of x11-toolkits/gtk20-reference and devel/glib20-reference to /usr/local/s
hare/gtk-doc/html.

Other possible fix is creating symlinks on /usr/local/share/gtk-doc/html like:
# ln -s ../../doc/gtk/gtk/ gtk
# ln -s ../../doc/gtk/gdk/ gdk
How-To-Repeat: Install x11-toolkits/gtk20-reference and devel/devhelp. Start devhelp and try to look for GTK/GDK documentation.
Comment 1 Edwin Groothuis freebsd_committer freebsd_triage 2012-11-12 13:00:14 UTC
Responsible Changed
From-To: freebsd-ports-bugs->gnome

Over to maintainer (via the GNATS Auto Assign Tool)
Comment 2 dfilter service freebsd_committer freebsd_triage 2013-05-22 12:32:37 UTC
Author: kwm
Date: Wed May 22 11:32:22 2013
New Revision: 318761
URL: http://svnweb.freebsd.org/changeset/ports/318761

Log:
  Make PORTDOCS in the -reference framework overwriteable.
  So some of the -reference ports that install multiple docs or "books" can
  make sure they get installed correctly. This impacts the -reference ports
  of glib20, gtk20 and gtk30.
  
  The problem was that for example in glib20 the reference was installed in
  share/doc/glib/{glib,gio,gobject} however devhelp only look in
  share/doc/${book} for the *.devhelp2 file.
  
  PR:		ports/173577
  Submitted by:	Victor Balada Diaz <victor@bsdes.net>

Modified:
  head/devel/glib20-reference/Makefile   (contents, props changed)
  head/devel/glib20-reference/bsd.gnome-reference.mk   (contents, props changed)
  head/x11-toolkits/gtk20-reference/Makefile   (contents, props changed)
  head/x11-toolkits/gtk30-reference/Makefile   (contents, props changed)

Modified: head/devel/glib20-reference/Makefile
==============================================================================
--- head/devel/glib20-reference/Makefile	Wed May 22 09:48:12 2013	(r318760)
+++ head/devel/glib20-reference/Makefile	Wed May 22 11:32:22 2013	(r318761)
@@ -9,6 +9,12 @@ PORTREVISION=	1
 
 BOOKS=		glib gobject gio
 
+# custom DOCSDIR. This is because we want the references to be installed
+# in share/doc/${book} and not share/doc/glib/${book}
+DOCSDIR=	${PREFIX}/share/doc
+
+PORTDOCS=	glib/* gobject/* gio/*
+
 glib_MAN=	glib-gettextize.1
 gobject_MAN=	glib-genmarshal.1 glib-mkenums.1 gobject-query.1
 

Modified: head/devel/glib20-reference/bsd.gnome-reference.mk
==============================================================================
--- head/devel/glib20-reference/bsd.gnome-reference.mk	Wed May 22 09:48:12 2013	(r318760)
+++ head/devel/glib20-reference/bsd.gnome-reference.mk	Wed May 22 11:32:22 2013	(r318761)
@@ -35,7 +35,7 @@ DISTINFO_FILE=	${PARENTDIR}/distinfo
 REFERENCE_SRC?=	${WRKSRC}/docs/reference
 BOOKS?=		.
 
-PORTDOCS=	*
+PORTDOCS?=	*
 
 .if !target(do-build)
 do-build:

Modified: head/x11-toolkits/gtk20-reference/Makefile
==============================================================================
--- head/x11-toolkits/gtk20-reference/Makefile	Wed May 22 09:48:12 2013	(r318760)
+++ head/x11-toolkits/gtk20-reference/Makefile	Wed May 22 11:32:22 2013	(r318761)
@@ -1,12 +1,13 @@
-# New ports collection makefile for:	gtk20-reference
-# Date created:				09 May 2006
-# Whom:					Jean-Yves Lefort <jylefort@FreeBSD.org>
-#
+# Created by: Jean-Yves Lefort <jylefort@FreeBSD.org>
 # $FreeBSD$
-#
 
-PORTREVISION=	2
+PORTREVISION=	0
+
+# custom DOCSDIR. This is because we want the references to be installed
+# in share/doc/${book} and not share/doc/gtk/${book}
+DOCSDIR=       ${PREFIX}/share/doc
 
 BOOKS=		gdk gtk
+PORTDOCS=	gdk/* gtk/*
 
 .include "${.CURDIR}/../../devel/glib20-reference/bsd.gnome-reference.mk"

Modified: head/x11-toolkits/gtk30-reference/Makefile
==============================================================================
--- head/x11-toolkits/gtk30-reference/Makefile	Wed May 22 09:48:12 2013	(r318760)
+++ head/x11-toolkits/gtk30-reference/Makefile	Wed May 22 11:32:22 2013	(r318761)
@@ -1,12 +1,14 @@
-# New ports collection makefile for:	gtk20-reference
-# Date created:				09 May 2006
-# Whom:					Jean-Yves Lefort <jylefort@FreeBSD.org>
-#
+# Created by: Jean-Yves Lefort <jylefort@FreeBSD.org>
 # $FreeBSD$
-#
 
-PORTREVISION=	0
+PORTREVISION=	1
+
+# custom DOCSDIR. This is because we want the references to be installed
+# in share/doc/${book} and not share/doc/gtk/${book}
+DOCSDIR=       ${PREFIX}/share/doc
 
 BOOKS=		gdk gtk
 
+PORTDOCS=	gdk/* gtk/*
+
 .include "${.CURDIR}/../../devel/glib20-reference/bsd.gnome-reference.mk"
_______________________________________________
svn-ports-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-ports-all
To unsubscribe, send any mail to "svn-ports-all-unsubscribe@freebsd.org"
Comment 3 Koop Mast freebsd_committer freebsd_triage 2013-05-22 12:32:42 UTC
State Changed
From-To: open->closed

A fix for this problem was committed, thanks for reporting!