updated

svn path=/trunk/; revision=1339

1 files changed, 18 insertions, 34 deletions

diff --git a/PORTING b/PORTING
index fba4ce4d..25c45f64 100644
--- a/PORTING
+++ b/PORTING
@@ -12,43 +12,19 @@ to the new release from the prior version.
 Porting from GMime 2.2 to GMime 2.4
 -----------------------------------
 
-GMime 2.4 is much the same as GMime 2.2 except that ALL public APIs
-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.
+GMime 2.4 has had a number of API changes since GMime 2.2. To start,
+ALL public APIs 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 enabled.
 
-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:
+In addition, all of the functions marked as deprecated in 2.0 and 2.2
+were removed (usually they had equivalent functionality in a parent
+class).
 
-- g_mime_stream_ref()
-- g_mime_stream_unref()
+Many functions have also been renamed for better clarity and/or
+consistency.
 
-- 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.
-
-For the sake of consistency, functions such as g_mime_cipher_sign()
-were renamed to g_mime_cipher_context_sign() in order to match their
-class name. The old names have been deprecated but the symbols are
-still there to ease migration. Below is a mapping of the function name
-changes:
+Below is a mapping of the function name changes:
 
 GMime 2.2 Name            | GMime 2.4 Name
 -------------------------------------------------------------
@@ -62,6 +38,14 @@ g_mime_cipher_import_keys   g_mime_cipher_context_import_keys
 g_mime_cipher_export_keys   g_mime_cipher_context_export_keys
 
 
+For convenience, GMime 2.4 source packages include a shell-script to
+aid in porting applications using GMime 2.2 (should work for most
+GMime 2.0 applications as well) to the 2.4 API. You can find this
+script under the tools/ directory, named `gmime-port-2-2-to-2-4.sh'.
+
+This script won't fix everything, but it should help quite a bit.
+
+
 Porting from GMime 2.0 to GMime 2.2
 -----------------------------------