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 673656 - Fix documentation comments
Fix documentation comments
Status: RESOLVED FIXED
Product: gnome-shell
Classification: Core
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gnome-shell-maint
gnome-shell-maint
Depends on:
Blocks:
 
 
Reported: 2012-04-06 18:40 UTC by Giovanni Campagna
Modified: 2012-04-09 17:59 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Fix documentation warnings (15.73 KB, patch)
2012-04-06 18:41 UTC, Giovanni Campagna
reviewed Details | Review
Fix documentation warnings (16.23 KB, patch)
2012-04-07 13:05 UTC, Giovanni Campagna
committed Details | Review

Description Giovanni Campagna 2012-04-06 18:40:38 UTC
gobject-introspection master is much pickier when it comes to malformed comments, and that fails building GIRs with --warn-error
Comment 1 Giovanni Campagna 2012-04-06 18:41:25 UTC
Created attachment 211500 [details] [review]
Fix documentation warnings

gobject-introspection now emits many more warnings for malformed
comments, and they fail the build.
Comment 2 Colin Walters 2012-04-06 18:44:50 UTC
Review of attachment 211500 [details] [review]:

One comment, otherwise looks great:

::: src/st/st-types.h
@@ +16,3 @@
  */
 
+#ifndef __GI_SCANNER__

Why?
Comment 3 Giovanni Campagna 2012-04-06 18:49:43 UTC
Because st-types.h is included from all source files, so g-ir-scanner sees that comment multiple times and complains.
Maybe it can be considered a bug in gobject-introspection, but that seemed the fastest fix.
Comment 4 Johan (not receiving bugmail) Dahlin 2012-04-06 20:33:29 UTC
(In reply to comment #3)
> Because st-types.h is included from all source files, so g-ir-scanner sees that
> comment multiple times and complains.
> Maybe it can be considered a bug in gobject-introspection, but that seemed the
> fastest fix.

That's clearly a bug. The hardest part of fixing this is creating a reproducible test case for g-i, can you help out with that?
Comment 5 Jasper St. Pierre (not reading bugmail) 2012-04-06 23:23:48 UTC
OK, it's our bug. Just moving the comment inside the header guards fixes it.

And Giovanni, can you port the gvc changes "upstream" (I think gnome-control-center and gnome-settings-daemon have copies)
Comment 6 Giovanni Campagna 2012-04-07 13:05:27 UTC
Created attachment 211540 [details] [review]
Fix documentation warnings

gobject-introspection now emits many more warnings for malformed
comments, and they fail the build.


Found in IRC the cause of the problem, SECTION:st-types was not
protected by header guards.
Comment 7 Jasper St. Pierre (not reading bugmail) 2012-04-07 15:27:27 UTC
Review of attachment 211540 [details] [review]:

Looks fine.
Comment 8 Jasper St. Pierre (not reading bugmail) 2012-04-09 16:43:44 UTC
Ping? This is breaking the build -- a push would be appreciated.
Comment 9 Jasper St. Pierre (not reading bugmail) 2012-04-09 16:45:47 UTC
( mutter is still broken, the fix for that is in bug #673752 )
Comment 10 Giovanni Campagna 2012-04-09 17:59:10 UTC
Attachment 211540 [details] pushed as 55a4517 - Fix documentation warnings
Sorry, I had system problems yesterday
(not counting it was easter...)