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 705633 - (patch) gtkdoc-scan: don't add the title until all symbols have been added
(patch) gtkdoc-scan: don't add the title until all symbols have been added
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2013-08-07 18:32 UTC by Alexander Kanavin
Modified: 2014-02-09 12:08 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
the patch to fix the problem (1.76 KB, patch)
2013-08-07 18:32 UTC, Alexander Kanavin 		none Details | Review
the patch to fix the problem (1.81 KB, patch)
2013-08-09 13:37 UTC, Alexander Kanavin 		committed Details | Review
testcase for this bug (1.58 KB, patch)
2013-08-09 17:34 UTC, Alexander Kanavin 		committed Details | Review
tests: add testcase for bug #705633 (1.60 KB, patch)
2014-02-09 12:08 UTC, Stefan Sauer (gstreamer, gtkdoc dev) 		committed Details | Review

Description Alexander Kanavin 2013-08-07 18:32:57 UTC 
Created attachment 251097 [details] [review]
the patch to fix the problem

Previously, adding "SomeSymbol" using AddSymbolToList() didn't work if  <TITLE>SomeSymbol</TITLE> was already there, due to regexp in AddSymbolToList that would reject the addition. I fixed the order, rather than the regexp (see the patch).

This problem happens for example with glib interface definitions where the interface name is added as a section title, but not as a symbol in the section, which results in incomplete -sections.txt file and accordingly incomplete generated documentation.
Comment 1 Alexander Kanavin 2013-08-09 13:37:38 UTC 
Created attachment 251236 [details] [review]
the patch to fix the problem

added bugzilla bug URL to the commit message
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2013-08-09 16:05:41 UTC 
Thanks for the patch, if you can make a patch for the tests too, that would be awesome.
Comment 3 Alexander Kanavin 2013-08-09 17:34:11 UTC 
Created attachment 251253 [details] [review]
testcase for this bug

There you go sir.
Comment 4 Alexander Kanavin 2013-08-09 17:35:20 UTC 
(changed the status back so that the testcase patch doesn't slip through the cracks)
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2014-02-09 12:08:48 UTC 
The following fix has been pushed:
875aca2 tests: add testcase for bug #705633
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2014-02-09 12:08:54 UTC 
Created attachment 268571 [details] [review]
tests: add testcase for bug #705633