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

Improve the documentation about single include exceptions

Browse Source 
Also, reenable the compiling Glib application section
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=612736
This commit is contained in:
Javier Jardón 2010-03-12 20:37:04 +01:00
parent 5b19345246
commit 62a133f55d
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

1
docs/reference/glib/glib-docs.sgml
View File

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