luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 15:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update deprecation docs

Browse Source
This commit is contained in:
Matthias Clasen 2011-11-03 00:05:29 -04:00
parent 03766a1a38
commit 07bcb3f8d6
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/reference/glib/compiling.sgml
View File

@ -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>