summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2009-12-09 23:54:17 +0100
committerJavier Jardón <jjardon@gnome.org>2009-12-15 20:10:20 +0100
commit44cadd2a48f93dd40a04ac83b157a78b2db0ffb3 (patch)
tree77b27f8561b1da51544812c642a6c98241a2bb65 /docs
parente8ed566898ed71b9cf2ee21be04bde9113332969 (diff)
downloadgdk-pixbuf-44cadd2a48f93dd40a04ac83b157a78b2db0ffb3.tar.gz
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
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gtk/compiling.sgml15
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/reference/gtk/compiling.sgml b/docs/reference/gtk/compiling.sgml
index daca56e69..a9a3632a9 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>
-
-
-
-