[Boost-commit] svn:boost r65499 - branches/release/libs/serialization/doc

Subject: [Boost-commit] svn:boost r65499 - branches/release/libs/serialization/doc
From: ramey_at_[hidden]
Date: 2010-09-21 00:41:52

Author: ramey
Date: 2010-09-21 00:41:48 EDT (Tue, 21 Sep 2010)
New Revision: 65499
URL: http://svn.boost.org/trac/boost/changeset/65499

Log:
documentation correction - especially fix for 1.42/1.43 binary archive problem
Properties modified: 
   branches/release/libs/serialization/doc/   (props changed)
Text files modified: 
   branches/release/libs/serialization/doc/contents.html      |    18 ++++++++++--------                      
   branches/release/libs/serialization/doc/release.html       |    18 ++++++++++++++++++                      
   branches/release/libs/serialization/doc/serialization.html |    12 +++++-------                            
   3 files changed, 33 insertions(+), 15 deletions(-)

Modified: branches/release/libs/serialization/doc/contents.html
==============================================================================
--- branches/release/libs/serialization/doc/contents.html	(original)
+++ branches/release/libs/serialization/doc/contents.html	2010-09-21 00:41:48 EDT (Tue, 21 Sep 2010)
@@ -86,14 +86,16 @@
 <dl class="page-index">
   <dt><img style="display:none" src="plus.gif" id="release_notes"><a target="detail" href="release.html">Release Notes</a></dt>
   <dd><div id="release_notes_detail"><dl class="page-index">
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_41">Differences from version 1.41</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_40">Differences from version 1.40</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_39">Differences from version 1.39</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_37">Differences from version 1.37</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_35">Differences from version 1.35</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_34">Differences from version 1.34</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_33">Differences from version 1.33</a></dt>
-    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#difference_1_32">Differences from version 1.32</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_43">Differences from version 1.43</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_42">Differences from version 1.42</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_41">Differences from version 1.41</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_40">Differences from version 1.40</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_39">Differences from version 1.39</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_37">Differences from version 1.37</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_35">Differences from version 1.35</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_34">Differences from version 1.34</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_33">Differences from version 1.33</a></dt>
+    <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#differences_1_32">Differences from version 1.32</a></dt>
 
     <dt><img style="display:none" src="dot.gif"><a target="detail"  href="release.html#todo">Pending Issues</a></dt>
   </dl></div></dd>

Modified: branches/release/libs/serialization/doc/release.html
==============================================================================
--- branches/release/libs/serialization/doc/release.html	(original)
+++ branches/release/libs/serialization/doc/release.html	2010-09-21 00:41:48 EDT (Tue, 21 Sep 2010)
@@ -48,6 +48,24 @@
 <ul>
     <li>fixed bug in the serialization of virtual base classes.  Due
     to heroic efforts by Takatoshi Kondo.
+    <li>Native binary archives created under versions 1.42 and 1.43
+    suffer from a serious problem.  It's likely they won't be readable
+    by this latest version. This due to the fact that 1.42 made some
+    changes in the binary format of some types.  Normally this could
+    be addressed by detecting the library version number written into
+    the archive header.  Unfortunately, this library version number
+    was not incremented at 1.42 as it should have been.  So now we have
+    two different binary archive versions with the same library version
+    number.
+    <p>
+    This has been addressed by including a small utility in the example
+    directory named fix_six.cpp.  This should be run with the command line<br>
+    <code><pre>
+    fix_six &lt;file name&gt;
+    </pre></code>
+    This will assign 7 to the library version number of the archive. This
+    fix will need to ba applied to native binary archives created with
+    boost versions 1.42 and 1.43.
 </ul>
 <h2><a name="differences_1_42"></a>Differences from Boost 1.42</h2>
 <ul>

Modified: branches/release/libs/serialization/doc/serialization.html
==============================================================================
--- branches/release/libs/serialization/doc/serialization.html	(original)
+++ branches/release/libs/serialization/doc/serialization.html	2010-09-21 00:41:48 EDT (Tue, 21 Sep 2010)
@@ -71,13 +71,11 @@
 if and only if one of the following is true:
 <ul>
   <li>it is a primitive type.<br>
-    In this document, we use the term primitive type to mean
-    types whose data is simply saved/loaded to/from an archive
-    with no further processing.  Arithmetic (including characters), 
-    bool, enum and stl::string and stl::wstring types are primitive types.  Using 
-    <a target="detail" href="traits.html#Traits">serialization traits</a>,
-    any user type can also be designated as "primitive"
-    so that it is handled in this way.
+    By <i>primitive type</i> we mean a C++ built-in type and <i>ONLY</i>
+    a C++ built-in type. Arithmetic (including characters), bool, enum are primitive types.
+    Below in <a target="detail" href="traits.html#Traits">serialization traits</a>,
+    we define a "primitive" implementation level in a different way for a 
+    different purpose.  This can be a source of confusion.
   <li>It is a class type and one of the following has been declared according
     to the prototypes detailed below:
     <ul>