release-notes r1071 - in branches/gnome-2-24: . help/C

[davyd svn gnome org]

Author: davyd
Date: Mon Sep 15 13:43:59 2008
New Revision: 1071
URL: http://svn.gnome.org/viewvc/release-notes?rev=1071&view=rev

Log:
2008-09-15  Davyd Madeley  <davyd madeley id au>

        * help/C/rndevelopers.xml: replace information that was just plain
          wrong


Modified:
   branches/gnome-2-24/ChangeLog
   branches/gnome-2-24/help/C/rndevelopers.xml

Modified: branches/gnome-2-24/help/C/rndevelopers.xml
==============================================================================
--- branches/gnome-2-24/help/C/rndevelopers.xml	(original)
+++ branches/gnome-2-24/help/C/rndevelopers.xml	Mon Sep 15 13:43:59 2008
@@ -15,35 +15,64 @@
 		&gnomeversion; developer platform.
 	</para>
 
-	<sect2 id="rndevelopers.glib">
-		<title>GLib &glibversion;</title>
+	<sect2 id="rndevelopers.threepointoh">
+		<title>Preparing for GLib/GTK+ 3.0</title>
+		<para>
+			In order to begin preparing developers for GLib and GTK+ 3.0, upcoming
+			releases of both libraries will include flags to enforce stricter
+			compatibility.
+		</para>
 
 		<para>
-			GLib &glibversion;
-			requires that only top-level headers (e.g. <filename>glib.h</filename>,
+			GLib, GTK+ and ATK 3.0 will
+			require that only top-level headers (e.g. <filename>glib.h</filename>,
 			<filename>gobject.h</filename>, <filename>gio.h</filename>) are included
-			in applications. <!-- FIXME: why are we making this change? -->
+			in applications. This change is important to allow individual headers
+			to be removed, renamed and rearranged without affecting source code
+			compatibility for applications.
+		</para>
+		<para>
+			To allow developers to test their applications for compatibility now,
+			two new compile time options have been provided:
+			G_DISABLE_SINGLE_INCLUDES for GLib,
+			GTK_DISABLE_SINGLE_INCLUDES for GTK+ and
+			ATK_DISABLE_SINGLE_INCLUDES for ATK.
+		</para>
+		<para>
+			Simply pass these as compile time flags when building your application
+			(e.g. <command>-DG_DISABLE_SINGLE_INCLUDES</command>) to ensure that
+			your application is correct.
 		</para>
-		<tip id="rndevelopers.glib.compat">
-			<title>Compatibility With Existing Codebases</title>
+
+		<tip id="rndevelopers.threepointoh.more">
+			<title>Further Compatibility Testing</title>
+
+			<para>
+				GLib, GTK+ and associated libraries also provide other compile time
+				options that you can use
+				to test compatibility with GTK+ 3.0.
+			</para>
 			<para>
-				There are some existing codebases that will no longer compile because
-				they include non-toplevel headers. This new mode can be overriden by
-				defining <emphasis>G_DISABLE_SINGLE_INCLUDES</emphasis>
-				for GLib and <emphasis>GTK_DISABLE_SINGLE_INCLUDES</emphasis> for GTK+
-				(e.g. as a CFLAG).
+				You can disable support for deprecated symbols and classes that will
+				be removed in version 3.0 by defining the following when compiling:
+				ATK_DISABLE_DEPRECATED,
+				PANGO_DISABLE_DEPRECATED, G_DISABLE_DEPRECATED,
+				GDK_PIXBUF_DISABLE_DEPRECATED,
+				GDK_DISABLE_DEPRECATED and GTK_DISABLE_DEPRECATED for ATK, Pango, GLib,
+				GdkPixbuf, GDK and GTK+ respectively.
 			</para>
 			<para>
-				For example, to compile a program that would otherwise be broken:
+				You can test that your program only uses functions that properly
+				support multihead (multiple monitor) systems by defining
+				GDK_MULTIHEAD_SAFE and GTK_MULTIHEAD_SAFE.
 			</para>
-			<informalexample>
-				<programlisting>
-CFLAGS="-DG_DISABLE_SINGLE_INCLUDES -DGTK_DISABLE_SINGLE_INCLUDES -O2 -g" ./configure --prefix=...</programlisting>
-			</informalexample>
 		</tip>
+	</sect2>
 
+ 	<sect2 id="rndevelopers.glib">
+		<title>GLib &glibversion;</title>
 		<para>
-			GLib &glibversion; also features better support for providing context
+			GLib &glibversion; features better support for providing context
 			in string translations with C_() and NC_() macros.
 			<!-- FIXME, write more -->
 		</para>