glib r6945 - in trunk/docs/reference: . glib

[matthiasc svn gnome org]

Author: matthiasc
Date: Tue May 27 16:46:43 2008
New Revision: 6945
URL: http://svn.gnome.org/viewvc/glib?rev=6945&view=rev

Log:
Additions


Modified:
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/glib/compiling.sgml

Modified: trunk/docs/reference/glib/compiling.sgml
==============================================================================
--- trunk/docs/reference/glib/compiling.sgml	(original)
+++ trunk/docs/reference/glib/compiling.sgml	Tue May 27 16:46:43 2008
@@ -67,6 +67,18 @@
 by using the command line option <literal>-DG_DISABLE_DEPRECATED=1</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.17, GLib enforces this this by generating an error
+when individual headers are directly included. To help with the 
+transition, the enforcement is not turned on by default for GLib 
+headers (it <emphasis>is</emphasis> turned on for GObject and GIO).
+To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES
+by using the command line option <literal>-DG_DISABLE_SINGLE_INCLUDES</literal>.
+</para>
+
 </refsect1>
 
 </refentry>