gmime r1348 - in trunk: . docs/reference

[fejj svn gnome org]

Author: fejj
Date: Sun Jun  8 14:54:36 2008
New Revision: 1348
URL: http://svn.gnome.org/viewvc/gmime?rev=1348&view=rev

Log:
2008-06-08  Jeffrey Stedfast  <fejj novell com>

	* docs/reference/changes-2.4.sgml: Updated.

	* PORTING: Updated.



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

Modified: trunk/PORTING
==============================================================================
--- trunk/PORTING	(original)
+++ trunk/PORTING	Sun Jun  8 14:54:36 2008
@@ -22,28 +22,28 @@
 class).
 
 Many functions have also been renamed for better clarity and/or
-consistency.
+consistency. 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'.
 
-Below is a mapping of the function name changes:
+This script won't fix everything, but it should help quite a bit.
 
-GMime 2.2 Name            | GMime 2.4 Name
--------------------------------------------------------------
-g_mime_cipher_hash_id       g_mime_cipher_context_hash_id
-g_mime_cipher_hash_name     g_mime_cipher_context_hash_name
-g_mime_cipher_sign          g_mime_cipher_context_sign
-g_mime_cipher_verify        g_mime_cipher_context_verify
-g_mime_cipher_encrypt       g_mime_cipher_context_encrypt
-g_mime_cipher_decrypt       g_mime_cipher_context_decrypt
-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'.
+Beyond that, a few methods have changed in other ways:
 
-This script won't fix everything, but it should help quite a bit.
+- g_mime_cipher_context_sign() still returns int, but if the value
+  isn't -1 (failure), then it will represent a GMimeCipherHash that it
+  used for signing. This is useful, for example, when the requested
+  hash was GMIME_CIPHER_HASH_DEFAULT.
+
+- g_mime_cipher_context_decrypt() now returns a GMimeSignatureValidty
+  on success and NULL on failure. This is needed in case the encrypted
+  stream was also signed.
+
+- g_mime_multipart_encrypted_encrypt() now takes a boolean 'sign'
+  argument to allow the caller to request encrypting and signing in a
+  single pass.
 
 
 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	Sun Jun  8 14:54:36 2008
@@ -10,62 +10,35 @@
   </refnamediv>
   <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 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>
-  <refsect1>
-    <title>Newly Deprecated Functions in GMime 2.4</title>
-    <para>GMimeCipherContext methods have been renamed from
-<function>g_mime_cipher_*</function> to
-<function>g_mime_cipher_context_*</function>. The 2.2 to 2.4 name mapping is as
-follows:</para>
+    <para>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.</para>
+    <para>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).</para>
+    <para>Many functions have also been renamed for better clarity
+and/or consistency. 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'.</para>
+    <para>This script won't fix everything, but it should help quite a
+bit.</para>
+    <para>Beyond that, a few methods have changed in other ways:</para>
     <itemizedlist>
-      <listitem><function>g_mime_cipher_hash_id</function> has been renamed to <function>g_mime_cipher_context_hash_id</function></listitem>
-      <listitem><function>g_mime_cipher_hash_name</function> has been renamed to <function>g_mime_cipher_context_hash_name</function></listitem>
-      <listitem><function>g_mime_cipher_sign</function> has been renamed to <function>g_mime_cipher_context_sign</function></listitem>
-      <listitem><function>g_mime_cipher_verify</function> has been renamed to <function>g_mime_cipher_context_verify</function></listitem>
-      <listitem><function>g_mime_cipher_encrypt</function> has been renamed to <function>g_mime_cipher_context_encrypt</function></listitem>
-      <listitem><function>g_mime_cipher_decrypt</function> has been renamed to <function>g_mime_cipher_context_decrypt</function></listitem>
-      <listitem><function>g_mime_cipher_import_keys</function> has been renamed to <function>g_mime_cipher_context_import_keys</function></listitem>
-      <listitem><function>g_mime_cipher_export_keys</function> has been renamed to <function>g_mime_cipher_context_export_keys</function></listitem>
+      <listitem><para><function>g_mime_cipher_context_sign()</function>
+  still returns int, but if the value isn't -1 (failure), then it will
+  represent a GMimeCipherHash that it used for signing. This is
+  useful, for example, when the requested hash was
+  GMIME_CIPHER_HASH_DEFAULT.</para></listitem>
+      <listitem><para><function>g_mime_cipher_context_decrypt()</function>
+  now returns a GMimeSignatureValidty on success and NULL on
+  failure. This is needed in case the encrypted stream was also
+  signed.</para></listitem>
+      <listitem><para><function>g_mime_multipart_encrypted_encrypt()</function>
+  now takes a boolean 'sign' argument to allow the caller to request
+  encrypting and signing in a single pass.</para></listitem>
     </itemizedlist>
   </refsect1>
 </refentry>

Modified: trunk/docs/reference/gmime.hierarchy
==============================================================================
--- trunk/docs/reference/gmime.hierarchy	(original)
+++ trunk/docs/reference/gmime.hierarchy	Sun Jun  8 14:54:36 2008
@@ -36,3 +36,4 @@
     GMimeStreamMmap
     GMimeStreamNull
 GInterface
+  GTypePlugin