gmime r1264 - in trunk: . docs/reference

[fejj svn gnome org]

Author: fejj
Date: Sat May 24 13:05:02 2008
New Revision: 1264
URL: http://svn.gnome.org/viewvc/gmime?rev=1264&view=rev

Log:
updated PORTING and changes-2.4.sgml to reflect removed deprecated functions

Modified:
   trunk/PORTING
   trunk/docs/reference/changes-2.4.sgml

Modified: trunk/PORTING
==============================================================================
--- trunk/PORTING	(original)
+++ trunk/PORTING	Sat May 24 13:05:02 2008
@@ -17,6 +17,33 @@
 ABI do not change based on whether or not large file support is
 supported.
 
+In addition, some of the deprecated functions were removed if they had
+equivalent functionality in a parent class. The list of removed
+functions are as follows:
+
+- g_mime_stream_ref()
+- g_mime_stream_unref()
+
+- g_mime_object_ref()
+- g_mime_object_unref()
+
+- g_mime_part_to_string()
+- g_mime_part_write_to_stream()
+
+- g_mime_message_to_string()
+- g_mime_message_write_to_stream()
+
+If you were using any of the ref() or unref() functions listed above,
+you can replace them with calls to g_object_ref() or g_object_unref()
+instead.
+
+Calls to g_mime_part_to_string() or g_mime_message_to_string() should
+be replaced with calls to g_mime_object_to_string() instead.
+
+Similarly, calls to g_mime_part_write_to_stream() or
+g_mime_message_write_to_stream() should be replaced with calls to
+g_mime_object_write_to_stream() instead.
+
 
 Porting from GMime 2.0 to GMime 2.2
 -----------------------------------

Modified: trunk/docs/reference/changes-2.4.sgml
==============================================================================
--- trunk/docs/reference/changes-2.4.sgml	(original)
+++ trunk/docs/reference/changes-2.4.sgml	Sat May 24 13:05:02 2008
@@ -11,9 +11,44 @@
   <refsect1>
     <title>Changes from 2.2 to 2.4</title>
     <para>See also the PORTING document in the toplevel GMime source directory.</para>
-    <para>There are no incompatible changes between 2.2 and 2.4.</para>
+    <para>There are no incompatible changes between 2.2 and 2.4 if you stayed
+away from the functions marked as deprecated.</para>
     <para>GMime 2.4's API is identical to GMime 2.2 except that ALL public
 interfaces that used to use off_t in GMime 2.2 now use gint64 so that the API
 and ABI do not change based on whether or not large file support is supported.</para>
   </refsect1>
+  <refsect1>
+    <title>Deprecated Functions removed from GMime 2.4</title>
+    <itemizedlist>
+      <listitem>
+        <para>Ref and Unref Functions</para>
+        <para>
+          <function>g_mime_stream_ref</function> and
+<function>g_mime_object_ref</function> have been removed. You should replace
+these calls with <function>g_object_ref</function> instead.
+        </para>
+        <para>
+          <function>g_mime_stream_unref</function> and
+<function>g_mime_object_unref</function> have been removed. You should replace
+these calls with <function>g_object_unref</function> instead.
+        </para>
+      </listitem>
+      <listitem>
+        <para>ToString Functions</para>
+        <para>
+          <function>g_mime_message_to_string</function> and
+<function>g_mime_part_to_string</function> have been removed. You should replace
+these calls with <function>g_mime_object_to_string</function> instead.
+        </para>
+      </listitem>
+      <listitem>
+        <para>WriteToStream Functions</para>
+        <para>
+          <function>g_mime_message_write_to_stream</function> and
+<function>g_mime_part_write_to_stream</function> have been removed. You should
+replace these calls with <function>g_mime_object_write_to_stream</function> instead.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </refsect1>
 </refentry>