GNOME Bugzilla – Bug 625827
Expand documentation about error quark naming
Last modified: 2010-08-05 07:50:45 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.
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. :)
(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.
Filed as bug #625839.
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.
Review of attachment 166974 [details] [review]: Looks fine
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(-)