[Bug 681635] Use GTKDOC_REBASE and GTK_DOC_USE_REBASE

[GStreamer (bugzilla.gnome.org)]

https://bugzilla.gnome.org/show_bug.cgi?id=681635
  GStreamer | common | git

--- Comment #7 from LRN <lrn1986 at gmail.com> 2012-08-11 20:40:47 UTC ---
(In reply to comment #6)
> (In reply to comment #5)
> > Oh, and the last bit i should have mentioned:
> > 
> > I don't like rebase, because it turns relative hrefs into _absolute_ hrefs.
> > This is bad already, as it hardcodes absolute paths into docs, making them
> > non-relocatable. And i see no profit in using absolute hrefs when every bit of
> > gtk-doc is in the same share/gtk-doc subdirectory, and can easily
> > cross-reference with relative hrefs just as well.
> 
> This is not the case. It is possible to have the docs in several places (e.g.
> when installing a devel version in home).
It is possible to have docs in several places. But that is not my case. I'm
only concerned with my case.

> > But it's worse than that. gtkdoc-rebase does not take into account that
> > "c:/mingw32/share/gtk-doc" is NOT a valid URI (on *nix something like
> > "/usr/share/gtk-doc" might be, i wouldn't know), and is not accepted by any W32
> > browser. It should be "file:///c:/mingw32/share/gtk-doc" instead. But gtk-doc
> > is not smart enough to figure that out. As a result, all rebased docs have
> > broken hrefs in them. Very annoying.
> 
> File a bug against gtk-doc please.
See #681663

> > Now, this might be fixed by patching gtk-doc to be smarter, but since NOT
> > rebasing the docs works just as well for me, i've taken the easier path -
> > fixing GStreamer.
> 
> Cool if it works for you, but you are aware that gtkdoc-rebase was not added
> just for the fun of it.
I'm aware. And i want it to work for me first, and solve everyone else's
problems second.

If gtkdoc-rebase is fixed, and you'd insist that what i'm doing (not rebasing
the docs) should not be possible or supported in any way, then i'd have to
implement a package manager for W32 (or try to use existing ones, which are
often low-quality; or port a good one), package gst docs with it, and find a
way to rebase docs every time they are installed (using some kind of
post-install script). Which will require bundling MSys with the package
manager, since gtkdoc is written in goddamn Perl, and (to me) doesn't look
portable (my own solution in such cases is to rewrite the program in Python,
with portability in mind (i suck at Perl), and that's even more work).

That would be the correct way of fixing this situation. And it would require
lots of work in several areas, which is not something i am willing to undertake
just now.

OR we could just agree to fix the way GStreamer invokes gtkdoc-rebase (which,
objectively, requires fixing - it doesn't make use of gtk-doc.m4 to its full
extent right now), which, as a useful (to me) side-effect, will allow me to not
to rebase docs, which works for me just fine, and will likely keep working for
me just fine until the issue can be fixed in a correct way.

P.S. Issue status is still "UNCONFIRMED", but the patch is
"accepted-commit_now". What does that mean?

-- 
Configure bugmail: https://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.