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 625827 - Expand documentation about error quark naming
Expand documentation about error quark naming
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: general
unspecified
Other Linux
: Normal minor
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2010-08-02 13:15 UTC by Philip Withnall
Modified: 2010-08-05 07:50 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Expand documentation about error quark naming (1.02 KB, patch)
2010-08-02 13:15 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2010-08-02 13:15:50 UTC
Created attachment 166974 [details] [review]
Expand documentation about error quark naming

Patch attached. This is useful to prevent people naming error quarks things like tp_errors_quark() which happened in telepathy-glib.
Comment 1 Dan Winship 2010-08-02 13:42:38 UTC
It should also say that if you didn't obey this convention, but you need to keep the old names for ABI-compatibility, then you should use a "Rename-To" annotation to fix the quark function name. And then, if that doesn't actually work, then the scanner needs to be fixed so that it does. :)
Comment 2 Philip Withnall 2010-08-02 14:08:13 UTC
(In reply to comment #1)
> It should also say that if you didn't obey this convention, but you need to
> keep the old names for ABI-compatibility, then you should use a "Rename-To"
> annotation to fix the quark function name. And then, if that doesn't actually
> work, then the scanner needs to be fixed so that it does. :)

The scanner needs to be fixed then, because it doesn't work.
Comment 3 Philip Withnall 2010-08-02 15:05:21 UTC
Filed as bug #625839.
Comment 4 Matthias Clasen 2010-08-05 05:14:11 UTC
I don't think the docs really need to mention abi stability; they just describe the typical convention for gerror use, and adding the one sentence about the quark function looks just fine to me.
Comment 5 Matthias Clasen 2010-08-05 05:15:40 UTC
Review of attachment 166974 [details] [review]:

Looks fine
Comment 6 Philip Withnall 2010-08-05 07:50:23 UTC
commit abe820e0d935f41744292146c71ccc4cf479751e
Author: Philip Withnall <philip.withnall@collabora.co.uk>
Date:   Mon Aug 2 14:14:11 2010 +0100

    Expand documentation about error quark naming
    
    Closes: bgo#625827

 docs/reference/glib/tmpl/error_reporting.sgml |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)