After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 318129 - enhance gtkdoc devhelp output
enhance gtkdoc devhelp output
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks: 310542
 
 
Reported: 2005-10-06 16:20 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2005-12-09 09:37 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
make the required changes (8.64 KB, patch)
2005-10-06 16:43 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
none Details | Review

Description Stefan Sauer (gstreamer, gtkdoc dev) 2005-10-06 16:20:18 UTC
The idea has been discussed at
http://mail.gnome.org/archives/gtk-doc-list/2005-August/msg00006.html
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2005-10-06 16:43:16 UTC
Created attachment 53120 [details] [review]
make the required changes
Comment 2 Damon Chaplin 2005-10-10 11:32:36 UTC
Yes, that looks OK to me.
Comment 3 Richard Hult 2005-11-19 18:05:07 UTC
It would be nice if the new format added a version attribute to the root node or
something like that so that devhelp can know which tags to look for.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2005-11-22 08:52:32 UTC
a different idea, wouldn't it be better to make .devhelp2 files with the new syntax?

Gtk-doc would get a configure option "--disable-devhelp1" or
"--disable-devhelp1-format". If given the stylesheets would be configured to not
produce the old format. This help distributors to keep the old files out, if the
ship a new devhelp that can read devhelp2 files.

Devhelp will always try devhelp2 files first and falls back to the old devhelp
files if there is no new one (yet).

Would that be better? Or should I just add a 'version="2"' attribute to the
top-level element.
Comment 5 Richard Hult 2005-11-22 14:03:11 UTC
I think making it output both the old and new format would make sense. I thought
that an old devhelp would be able to parse the new file since it has the old
function tag in it, but it turns out it bails out when it sees the new tag :/
Comment 6 Richard Hult 2005-11-22 19:27:09 UTC
We should also add a version tag to the new format anyway to make this kind of
change easier in the future.
Comment 7 Richard Hult 2005-12-05 16:21:09 UTC
Stefan, what do you think we should do here?
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2005-12-09 09:37:53 UTC
Richard, I've now commited the changes to produce two separate files.