[gmime] Updated reference manual for 2.6 changes



commit ebc17acc59336a4f844a0829ec9e4435bf3ec9b1
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Feb 6 12:26:23 2010 -0500

    Updated reference manual for 2.6 changes

 docs/reference/changes-2.6.sgml |   44 +++++++++++++++++++++++++++++++++++++++
 docs/reference/gmime-docs.sgml  |    6 +++-
 2 files changed, 48 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/changes-2.6.sgml b/docs/reference/changes-2.6.sgml
new file mode 100644
index 0000000..eee6a66
--- /dev/null
+++ b/docs/reference/changes-2.6.sgml
@@ -0,0 +1,44 @@
+<refentry id="gmime-changes-2-6" revision="06 Feb 2010">
+  <refmeta>
+    <refentrytitle>Changes from 2.4 to 2.6</refentrytitle>
+    <manvolnum>3</manvolnum>
+    <refmiscinfo>Changes from 2.4 to 2.6</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>Changes from 2.4 to 2.6</refname>
+    <refpurpose>Changes made between version 2.4 and version 2.6</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>Changes from 2.4 to 2.6</title>
+    <para>After releasing GMime 2.4, it was discovered that
+g_mime_stream_length() still returned ssize_t which, on 32bit systems,
+meant that the function was useless if the actual stream was larger
+than 2GB (which could happen if GMime was built with large file
+support).</para>
+    <para>As I fixed this, I also found some API inconsistencies which I felt I
+might as well fix up since I had to break API/ABI compatibility with
+2.4 anyway.</para>
+    <para>Most notable in GMime 2.6 is the lack of GMimeSession which has been
+dropped in favor of a much simpler callback
+mechanism. GMimeCipherContexts constructors now take a
+password_request callback function rather than forcing you to subclass
+GMimeSession to get this functionality.</para>
+    <para>Other API changes include:</para>
+    <itemizedlist>
+      <listitem><para>GMimeBestEncoding has been renamed to
+      GMimeEncodingConstraint</para></listitem>
+      <listitem><para><function>g_mime_signer_get_created()</function>
+  has been renamed to <function>g_mime_signer_get_sig_created()</function>.
+      </para></listitem>
+      <listitem><para><function>g_mime_signer_set_created()</function>
+  has been renamed to <function>g_mime_signer_set_sig_created()</function>.
+      </para></listitem>
+      <listitem><para><function>g_mime_signer_get_expires()</function>
+  has been renamed to <function>g_mime_signer_get_sig_expires()</function>.
+      </para></listitem>
+      <listitem><para><function>g_mime_signer_set_expires()</function>
+  has been renamed to <function>g_mime_signer_set_sig_expires()</function>.
+      </para></listitem>
+    </itemizedlist>
+  </refsect1>
+</refentry>
diff --git a/docs/reference/gmime-docs.sgml b/docs/reference/gmime-docs.sgml
index a5f6079..eb05b83 100644
--- a/docs/reference/gmime-docs.sgml
+++ b/docs/reference/gmime-docs.sgml
@@ -61,6 +61,7 @@
 <!ENTITY gmime-Changes-2-0 SYSTEM "changes-2.0.sgml">
 <!ENTITY gmime-Changes-2-2 SYSTEM "changes-2.2.sgml">
 <!ENTITY gmime-Changes-2-4 SYSTEM "changes-2.4.sgml">
+<!ENTITY gmime-Changes-2-6 SYSTEM "changes-2.6.sgml">
 
 <!ENTITY gmime-Streams SYSTEM "streams.sgml">
 <!ENTITY gmime-Filters SYSTEM "filters.sgml">
@@ -69,7 +70,7 @@
 
 <book id="index">
   <bookinfo>
-    <title>GMime 2.4 Reference Manual</title>
+    <title>GMime 2.6 Reference Manual</title>
     <authorgroup>
       <author>
         <firstname>Jeffrey</firstname>
@@ -82,7 +83,7 @@
       </author>
     </authorgroup>
     <copyright>
-      <year>2000-2009</year>
+      <year>2000-2010</year>
       <holder>Jeffrey Stedfast</holder>
     </copyright>
 
@@ -145,6 +146,7 @@ string utilities, file utilities, a main loop abstraction, and so on.
     &gmime-Changes-2-0;
     &gmime-Changes-2-2;
     &gmime-Changes-2-4;
+    &gmime-Changes-2-6;
     &gmime-Resources;
     &gmime-Questions;
   </part>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]