Bug 74894

Summary:	Failed check-def.sh
Product:	cairo	Reporter:	Daniel <dstrokis>
Component:	general	Assignee:	Bryce Harrington <bryce>
Status:	RESOLVED FIXED	QA Contact:	cairo-bugs mailing list <cairo-bugs>
Severity:	normal
Priority:	medium
Version:	1.12.14
Hardware:	Other
OS:	Linux (All)
Whiteboard:
i915 platform:		i915 features:
Bug Depends on:
Bug Blocks:	68382

Description Daniel 2014-02-12 17:58:24 UTC

Tried installing Cairo 1.12.14 release from (10 Feb 2014) on a VM at Koding.com. Ran ./configure & make commands. On running make check it failed 1 of 6 tests, and the one it failed was check-def.sh. This is what it returned:

FAIL: check-def.sh
Checking documentation for incorrect syntax
./cairo-types-private.h (148): WARNING: cairo_hash_entry_t: missing 'Since' field (is it a private type?)
./cairo-types-private.h (161): WARNING: cairo_hash_entry_t: not found
./cairo-types-private.h (175): WARNING: cairo_lcd_filter_t: missing 'Since' field (is it a private type?)
./cairo-cache-private.h (85): WARNING: cairo_cache_entry_t: missing 'Since' field (is it a private type?)
./cairo-region.c (856): WARNING: cairo_region_overlap_t: not found
./cairo-raster-source-pattern.c (62): WARNING: SECTION:cairo-raster-source 'Since' field in non-public element

Comment 1 Bryce Harrington 2014-03-15 01:49:31 UTC

commit bc05dbccd7dd2f137038479b30ed71c98ff81da6
Author: Uli Schlachter <psychon@znc.in>
Date:   Thu Feb 27 10:56:20 2014 +0100

    Fix warnings from check-doc-syntax.sh

    $ ./check-doc-syntax.sh
    Checking documentation for incorrect syntax
    ./cairo-types-private.h (148): WARNING: cairo_hash_entry_t: missing 'Since' field (is it a private type?)
    ./cairo-types-private.h (161): WARNING: cairo_hash_entry_t: not found
    ./cairo-types-private.h (175): WARNING: cairo_lcd_filter_t: missing 'Since' field (is it a private type?)
    ./cairo-cache-private.h (85): WARNING: cairo_cache_entry_t: missing 'Since' field (is it a private type?)
    ./cairo-region.c (857): WARNING: cairo_region_overlap_t: not found
    ./cairo-raster-source-pattern.c (62): WARNING: SECTION:cairo-raster-source 'Since' field in non-public element

    The warnings about missing 'Since' fields are fixed by changing the
    documentation comment so that the script can see that these are private types.

    The documentation for cairo_region_overlap_t gets moved to cairo.h, just like
    e.g. the documentation for cairo_status_t.

    The 'Since' field from the SECTION:cairo-raster-source is removed, because this
    kind of field is needed on the individual functions and structs, not on the
    section.

    Thanks to Bryce Harrington for bringing this up!

    Signed-off-by: Uli Schlachter <psychon@znc.in>
    Tested-by: Bryce Harrington <b.harrington@samsung.com>

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.