[glib] Improve the documentation about single include exceptions
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Improve the documentation about single include exceptions
- Date: Sat, 13 Mar 2010 00:33:46 +0000 (UTC)
commit 62a133f55dcd5626e9583aabc2d95926936a8475
Author: Javier Jardón <jjardon gnome org>
Date: Fri Mar 12 20:37:04 2010 +0100
Improve the documentation about single include exceptions
Also, reenable the compiling Glib application section
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=612736
docs/reference/glib/compiling.sgml | 9 +++++++++
docs/reference/glib/glib-docs.sgml | 1 +
2 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/glib/compiling.sgml b/docs/reference/glib/compiling.sgml
index 7036e2e..b12197d 100644
--- a/docs/reference/glib/compiling.sgml
+++ b/docs/reference/glib/compiling.sgml
@@ -75,6 +75,15 @@ by using the command line option <literal>-DG_DISABLE_DEPRECATED=1</literal>.
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>.
+Still, there are some exceptions; these headers have to be included separately:
+<filename>gmodule.h</filename>,
+<filename>glib/gi18n-lib.h</filename> or <filename>glib/gi18n.h</filename> (see
+the <link linkend="glib-I18N">Internationalization section</link>),
+<filename>glib/gprintf.h</filename> and <filename>glib/gstdio.h</filename>
+(we don't want to pull in all of stdio).
+</para>
+
+<para>
Starting with 2.17, GLib enforces 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
diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml
index 0ab911b..c63881d 100644
--- a/docs/reference/glib/glib-docs.sgml
+++ b/docs/reference/glib/glib-docs.sgml
@@ -32,6 +32,7 @@ synchronize their operation.
<xi:include href="building.sgml" />
<xi:include href="cross.sgml" />
+ <xi:include href="compiling.sgml" />
<xi:include href="running.sgml" />
<xi:include href="changes.sgml" />
<xi:include href="regex-syntax.sgml" />
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]