Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
G
gtk-doc
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 90
    • Issues 90
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 7
    • Merge Requests 7
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GNOME
  • gtk-doc
  • Issues
  • #19

Closed
Open
Opened Sep 06, 2011 by bugzilla-migration@bugzilla-migrationReporter

fixxref valid link check causes too many warnings

Submitted by Stefan Sauer (gstreamer, gtkdoc dev)

Link to original bug (#658359)

Description

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

Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: GNOME/gtk-doc#19