Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 333313 - dev-util/gtk-doc: gtkdoc-fixxref incompatible with vim-core-7.3
Summary: dev-util/gtk-doc: gtkdoc-fixxref incompatible with vim-core-7.3
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Linux Gnome Desktop Team
URL: https://bugzilla.gnome.org/show_bug.c...
Whiteboard:
Keywords: Inclusion
: 333481 334141 335410 341595 (view as bug list)
Depends on:
Blocks:
 
Reported: 2010-08-18 15:19 UTC by Ian Abbott
Modified: 2010-10-27 08:32 UTC (History)
9 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Patch as requested (gtk-doc-1.13-fixxref-vim-temp_source_file.html.patch,610 bytes, patch)
2010-08-23 22:13 UTC, Ed Catmur
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ian Abbott 2010-08-18 15:19:16 UTC
gtkdoc-fixxref (a Perl script) from dev-utils/gtk-doc-1.13-r2 or dev-utils/gtk-doc-1.15 automagically calls vim (if installed) to transform a source code file to a html with syntax highlighting. This is done by the HighlightSourceVim subroutine in gtkdoc-fixxref. It writes the source file to a temporary file named in the "$temp_source_file" variable, and expects the html output to be in "$temp_source_file.html". However, with vim-core-7.3 installed, the html output will actually be in "$temp_source_file.xhtml", so when gtkdoc-fixxref tries to open "$temp_source_file.html", it will find the file does not exist. This has knock-on effects for the remainder of the HighlightSourceVim subroutine and it will eventually die when it tries to unlink the non-existent file.

This bug stops various other packages with emerging with USE="doc", basically anything that uses gtkdoc-fixxref will fail to emerge, for example "media-gfx/gimp" or "dev-libs/totem-pl-parser" (both with USE="doc").

Reproducible: Always

Steps to Reproduce:
1. emerge -1 =app-editors/vim-core-7.3 =app-editors/vim-7.3
2. USE="doc" emerge -1 dev-libs/totem-pl-parser

Actual Results:  
The build of totem-pl-parser fails while running gtkdoc-fixxref


A relatively simple fix is to modify the line in the HighlightSourceVim subroutine in gtkdoc-fixxref.in that runs /usr/bin/vim.

Replace:

 wa!

with:

 w! $temp_source_file.html

in order to name the html output file explicitly to what is expected by the script. Note that this line is already modified by the "files/gtk-doc-1.13-fixxref-vim-u-NONE.patch" used to fix bug #306569, so I don't know if the maintainer would prefer to have two separate patches or a single patch that fixes both bugs.
Comment 1 Ian Abbott 2010-08-18 15:29:25 UTC
Upstream: https://bugzilla.gnome.org/show_bug.cgi?id=627223
Comment 2 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-18 16:27:01 UTC
sounds like a harmless change.
Comment 3 Petr Zima 2010-08-20 07:22:03 UTC
Similar error occurs for dev-libs/glib with USE=doc. Bug #333481 is a duplicate of this one.
Comment 4 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-20 09:38:29 UTC
*** Bug 333481 has been marked as a duplicate of this bug. ***
Comment 5 John Covici 2010-08-22 02:15:25 UTC
The indicated fix did not work for me, I still got the no such file or directory when trying to delete an html file.
Comment 6 Ian Abbott 2010-08-23 08:52:32 UTC
(In reply to comment #5)
> The indicated fix did not work for me, I still got the no such file or
> directory when trying to delete an html file.

On one of my systems, I got failures for some packages that were upgraded after vim-core was upgraded to 7.3, but before vim was upgraded to 7.3. Perhaps that happened for you as well?
Comment 7 Juergen Rose 2010-08-23 18:30:32 UTC
Where can I find a patch, which I can apply to totem-pl-parser, to fix the issue?

Regards
Comment 8 Ed Catmur 2010-08-23 22:13:51 UTC
Created attachment 244305 [details, diff]
Patch as requested

Note: this patch applies on top of (i.e. after) the current patch to the same line.
Comment 9 Ian Abbott 2010-08-23 23:01:11 UTC
Bug #334141 looks like a dupe of this.
Comment 10 Alexandre Rostovtsev (RETIRED) gentoo-dev 2010-08-28 03:03:58 UTC
This has been fixed in the upstream git tree: http://git.gnome.org/browse/gtk-doc/commit/?id=2bffebcf9c125f5610b8fb660d42c3c5b9dfd4f0

Please add Ed Catmur's patch to portage.
Comment 11 Pacho Ramos gentoo-dev 2010-09-02 11:57:40 UTC
*** Bug 334141 has been marked as a duplicate of this bug. ***
Comment 12 Pacho Ramos gentoo-dev 2010-09-02 11:58:07 UTC
*** Bug 335410 has been marked as a duplicate of this bug. ***
Comment 13 Pacho Ramos gentoo-dev 2010-09-02 12:37:03 UTC
+*gtk-doc-1.15-r1 (02 Sep 2010)
+
+  02 Sep 2010; Pacho Ramos <pacho@gentoo.org> gtk-doc-1.13-r2.ebuild,
+  gtk-doc-1.15.ebuild, +gtk-doc-1.15-r1.ebuild,
+  +files/gtk-doc-1.15-fixxref-vim-fixes.patch:
+  Revision bump to fix incompatibility with vim-7.3 reported in bug #333313
+  by Ian Abbott, Ed Catmur and others. Applied upstream patch for fixing
+  this and also replacing gtk-doc-1.13-fixxref-vim-u-NONE.patch. Added a
+  blocker to affected versions to prevent future breakage when vim-7.3
+  reaches stable.
+
Comment 14 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-10-27 08:32:12 UTC
*** Bug 341595 has been marked as a duplicate of this bug. ***