From 4f0f6243c913d4fa23bf7ddfe1c6f9f95cb48011 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Javier=20Jard=C3=B3n?= <jjardon@gnome.org>
Date: Wed, 9 Dec 2009 23:54:17 +0100
Subject: [PATCH] Add info about single includes when compiling GTK+ apps

gtk.h, gdk.h, gdk-pixbuf.h. are the recommended includes.
But there are some exceptions: gdkkeysyms.h, gdkx.h and
gtkunixprint.h

https://bugzilla.gnome.org/show_bug.cgi?id=604117
---
 docs/reference/gtk/compiling.sgml | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/reference/gtk/compiling.sgml b/docs/reference/gtk/compiling.sgml
index daca56e697..a9a3632a91 100644
--- a/docs/reference/gtk/compiling.sgml
+++ b/docs/reference/gtk/compiling.sgml
@@ -69,12 +69,17 @@ toplevel headers <filename>gtk.h</filename>, <filename>gdk.h</filename>,
 If you want to make sure that your program follows this recommended
 practise, you can define the preprocessor symbols GTK_DISABLE_SINGLE_INCLUDES
 and GDK_PIXBUF_DISABLE_SINGLE_INCLUDES to make GTK+ generate an error
-when individual headers are directly included. 
+when individual headers are directly included.
+There are some exceptions: <filename>gdkkeysyms.h</filename> is not included in
+<filename>gdk.h</filename> because the file is quite large; see
+<link linkend="gdk-Keyboard-Handling">Key Values documentation</link>.
+<filename>gdkx.h</filename> must be included independently because It's
+platform-specific; see
+<link linkend="gdk-X-Window-System-Interaction">X Window System Interaction</link>
+documentation.
+The same for <filename>gtkunixprint.h</filename> if you use the non-portable
+<link linkend="GtkPrintUnixDialog">GtkPrintUnixDialog</link> API.
 </para>
 
 </refsect1>
 </refentry>
-
-
-
-