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 658359 - fixxref valid link check causes too many warnings
fixxref valid link check causes too many warnings
Status: RESOLVED OBSOLETE
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2011-09-06 13:37 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2018-05-22 13:05 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Stefan Sauer (gstreamer, gtkdoc dev) 2011-09-06 13:37:02 UTC
While the fixxref valid link check is good at catching typos it also throws a lot of invalid warnings. We don't have a way to suppress them right now.

The reason is that gtk-doc opimistically creates links for function(), @CONSTANT, %parameter, #Object. Especially function() can also happen when someone e.g. writes "see posix_memalign()" or in code examples "foo()". Other links get created by gtkdoc for the parameter and return type table below functions/structs etc.

One strategy here could be to mark these implicit links to not warn. We can assume that the types are not misspelled as those would be caught by the compiler.

For explicit links we could use a supression file. The file could be:
# comment
posix_memalign man://posix_memalign
foo

The posix_memalign would tell gtkdoc how to link to it properly. the foo entry would cause gtkdoc to suppress the warning.

A different approach would be to e.g. have a tags for e.g. /usr/inlcude file and suppress warnings for valid symbols.

We could also consider to e.g. suppress warnings for entries in: nm -g --undefined-only $(builddir)/*.o
Comment 1 GNOME Infrastructure Team 2018-05-22 13:05:49 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk-doc/issues/19.