Bug 197899 - x11-libs/gtk+-2.12.1 fails to generate docs with dev-util/gtk-doc-1.6-r1
Bug#: 197899 Product:  Gentoo Linux Version: 2006.1 Platform: x86
OS/Version: Linux Status: RESOLVED Severity: minor Priority: P2
Resolution: FIXED Assigned To: gnome@gentoo.org Reported By: slava@fizlesh.org.ru
Component: Ebuilds
URL: 
Summary: x11-libs/gtk+-2.12.1 fails to generate docs with dev-util/gtk-doc-1.6-r1
Keywords:  
Status Whiteboard: 
Opened: 2007-11-02 20:19 0000
Description:   Opened: 2007-11-02 20:19 0000
Upgrade of gtk-doc to gtk-doc-1.8-r2 solves the problem. Please add it to the
dependencies of gtk+.

Reproducible: Always

------- Comment #1 From Thomas Raschbacher 2007-11-11 20:00:24 0000 -------
also happens with gtk-doc 1.7 here error output:

gtk-doc: Rebuilding template files
cd . && gtkdoc-mktmpl --module=gdk 
=============================================================================
WARNING: 2 unused declarations.
  These can be found in gdk-unused.txt.
  They should be added to gdk-sections.txt in the appropriate place.
=============================================================================
touch tmpl-build.stamp
gtk-doc: Building XML
cd . && \
        gtkdoc-mkdb --module=gdk --source-dir=../../../gdk --output-format=xml
--expand-content-files="" --main-sgml-file=gdk-docs.sgml --sgml-mode
--output-format=xml
WARNING: Documentation in template file for gdk_keymap_get_direction being
overridden by inline comments
100% symbol docs coverage (854 symbols documented, 0 symbols incomplete, 1 not
documented)
See gdk-undocumented.txt for a list of missing docs.
The doc coverage percentage doesn't include intro sections.
touch sgml-build.stamp
gtk-doc: Building HTML
rm -rf ./html 
mkdir ./html
cd ./html && gtkdoc-mkhtml gdk ../gdk-docs.sgml
../xml/threads.xml:444: parser error : Opening and ending tag mismatch:
programlisting line 439 and para
</para>
       ^
../xml/threads.xml:474: parser error : Opening and ending tag mismatch: para
line 465 and programlisting
</programlisting></informalexample></para>
                 ^
../xml/threads.xml:611: parser error : chunk is not well balanced

^
../gdk-docs.sgml:78: parser error : Failure to process entity gdk-Threads
    &gdk-Threads;
                 ^
../gdk-docs.sgml:78: parser error : Entity 'gdk-Threads' not defined
    &gdk-Threads;
                 ^
unable to parse ../gdk-docs.sgml
make[4]: *** [html-build.stamp] Error 6
make[4]: Leaving directory
`/mnt/space/Portage/tmp/portage/x11-libs/gtk+-2.12.1-r1/work/gtk+-2.12.1/docs/reference/gdk'
make[3]: *** [all-recursive] Error 1
make[3]: Leaving directory
`/mnt/space/Portage/tmp/portage/x11-libs/gtk+-2.12.1-r1/work/gtk+-2.12.1/docs/reference'
make[2]: *** [all-recursive] Error 1
make[2]: Leaving directory
`/mnt/space/Portage/tmp/portage/x11-libs/gtk+-2.12.1-r1/work/gtk+-2.12.1/docs'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory
`/mnt/space/Portage/tmp/portage/x11-libs/gtk+-2.12.1-r1/work/gtk+-2.12.1'
make: *** [all] Error 2

------- Comment #2 From Jakub Moc (RETIRED) 2008-02-15 02:34:17 0000 -------
*** Bug 210196 has been marked as a duplicate of this bug. ***

------- Comment #3 From jens.poenninghaus@uni-bielefeld.de 2008-02-15 07:57:53 0000 -------
Confirm: Upgrading gtk-doc solved the problem. Dependency should indeed be
adjusted to reflect this.
Thanks!

------- Comment #4 From Marcello Magaldi 2008-04-28 10:05:14 0000 -------
(In reply to comment #3)
> Confirm: Upgrading gtk-doc solved the problem. Dependency should indeed be
> adjusted to reflect this.
> Thanks!
> 

since upgrading to newer stable gtk-doc and gtk+ solve this issue is it time to
mark this bug as resolved fixed ?

------- Comment #5 From Slava Gorbunov 2008-04-28 10:51:06 0000 -------
(In reply to comment #4)
> since upgrading to newer stable gtk-doc and gtk+ solve this issue is it time to
> mark this bug as resolved fixed ?
I suppose no, because the dependency record should be updated. If you do
'emerge gtk+', and already have an older version of gtk-doc installed, it won't
be upgraded automatically unless the requirement of the newer version is stated
by DEPEND record in the ebuild. 

------- Comment #6 From Marcello Magaldi 2008-04-28 13:28:46 0000 -------
(In reply to comment #5)
> (In reply to comment #4)
> > since upgrading to newer stable gtk-doc and gtk+ solve this issue is it time to
> > mark this bug as resolved fixed ?
> I suppose no, because the dependency record should be updated. If you do
> 'emerge gtk+', and already have an older version of gtk-doc installed, it won't
> be upgraded automatically unless the requirement of the newer version is stated
> by DEPEND record in the ebuild. 

You are right , I didn't think about it since I always do an emerge -uDN world 
, but as you said gtk+ should depend on a more recent version of gtk-doc , only
doing this will pull gtk-doc to a newer version with an "emerge world" .  

------- Comment #7 From Gilles Dartiguelongue 2008-04-28 14:25:49 0000 -------
I just checked the svn and it appears upstream raised their dep as well so it's
safe to do it in our ebuild as well. Will proceed tonight.

------- Comment #8 From Gilles Dartiguelongue 2008-04-28 21:44:20 0000 -------
updated the dep. Thanks for reporting and sorry for taking so long to fix that
simple issue.