summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2011-10-11 23:50:34 -0400
committerMatthias Clasen <mclasen@redhat.com>2011-10-11 23:50:34 -0400
commitc6016458ba2a981ccd72f02208f8140abde6c9d1 (patch)
tree8675660b9b41425f027d9725fa7abecbd70eaba9 /docs
parent3d282dcc2ef1dba36e67f91d8a6c5f589ce249ea (diff)
Update deprecation docs
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/glib/compiling.sgml17
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/reference/glib/compiling.sgml b/docs/reference/glib/compiling.sgml
index 5ebef07ea..a47365391 100644
--- a/docs/reference/glib/compiling.sgml
+++ b/docs/reference/glib/compiling.sgml
@@ -71,9 +71,20 @@ $ cc `pkg-config --cflags --libs glib-2.0` hello.c -o hello
</para>
<para>
-If you want to make sure that your program doesn't use any deprecated
-functions, you can define the preprocessor symbol G_DISABLE_DEPRECATED
-by using the command line option <literal>-DG_DISABLE_DEPRECATED=1</literal>.
+Deprecated GLib functions are annotated to make the compiler
+emit warnings when they are used (e.g. with gcc, you need to use
+the -Wdeprecated-declarations option). If these warnings are
+problematic, they can be turned off by defining the preprocessor
+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.
</para>
<para>