From 62a133f55dcd5626e9583aabc2d95926936a8475 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Fri, 12 Mar 2010 20:37:04 +0100 Subject: [PATCH] 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(+) 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 -DG_DISABLE_DEPRECATED=1. The recommended way of using GLib has always been to only include the toplevel headers glib.h, glib-object.h, gio.h. +Still, there are some exceptions; these headers have to be included separately: +gmodule.h, +glib/gi18n-lib.h or glib/gi18n.h (see +the Internationalization section), +glib/gprintf.h and glib/gstdio.h +(we don't want to pull in all of stdio). + + + 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. + -- 2.7.4