[glib] Update deprecation docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Update deprecation docs
- Date: Thu, 3 Nov 2011 04:17:29 +0000 (UTC)
commit 07bcb3f8d6451de9d44c1ff5891f7fc79d8fa524
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Nov 3 00:05:29 2011 -0400
Update deprecation docs
docs/reference/glib/compiling.sgml | 21 ++++++++++-----------
1 files changed, 10 insertions(+), 11 deletions(-)
---
diff --git a/docs/reference/glib/compiling.sgml b/docs/reference/glib/compiling.sgml
index 9d20a58..cc72eda 100644
--- a/docs/reference/glib/compiling.sgml
+++ b/docs/reference/glib/compiling.sgml
@@ -79,18 +79,22 @@ symbol GLIB_DISABLE_DEPRECATION_WARNINGS by using the commandline
option <literal>-DGLIB_DISABLE_DEPRECATION_WARNINGS</literal>
</para>
<para>
-If you want to make <emphasis>really</emphasis> sure that your program
-doesn't use any deprecated functions, you can define the preprocessor
-symbol G_DISABLE_DEPRECATED by using the commandline option
-<literal>-DG_DISABLE_DEPRECATED</literal>. This will hide deprecated
-API from the compiler entirely, most likely causing your program's
-build to fail.
+The older deprecation mechanism of hiding deprecated interfaces
+entirely from the compiler by using the preprocessor symbol
+G_DISABLE_DEPRECATED is still used for deprecated macros,
+enumeration values, etc. To detect uses of these in your code,
+use the commandline option <literal>-DG_DISABLE_DEPRECATED</literal>.
</para>
<para>
The recommended way of using GLib has always been to only include the
toplevel headers <filename>glib.h</filename>,
<filename>glib-object.h</filename>, <filename>gio.h</filename>.
+Starting with 2.32, GLib enforces this by generating an error
+when individual headers are directly included.
+</para>
+
+<para>
Still, there are some exceptions; these headers have to be included
separately:
<filename>gmodule.h</filename>,
@@ -103,11 +107,6 @@ the <link linkend="glib-I18N">Internationalization section</link>),
(we don't want to pull in all of stdio).
</para>
-<para>
-Starting with 2.32, GLib enforces this by generating an error
-when individual headers are directly included.
-</para>
-
</refsect1>
</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]