Update documentation for 6.0.0

documentation/RELEASE_NOTES.html

@@ -1,6 +1,103 @@
-<h1>Release 5.0</h1>
+<h1>Release 6.0.0</h1>
 
-<p>The main changes since release 4.0 are:</p>
+<p>The main changes since release 5.0.4 are:</p>
+
+<ul>
+<li>Linux shared library version added</li>
+<li>Headers have been moved into pv directories</li>
+<li>Bitset functions declared const where possible</li>
+<li>Bitset::swap added</li>
+<li>Requester::message has default implementation</li>
+<li>Serialization/deserialization helpers added</li>
+<li>Non-template getSubField char* overload added</li>
+<li>MonitorPlugin deprecated</li>
+<li>Field name validation performed</li>
+<li>Now builds for Cygwin and MinGW targets</li>
+<li>Fix for debug build issue.</li>
+<li>New license file replaces LICENSE and COPYRIGHT</li>
+</ul>
+
+<h2>Shared library version added</h2>
+
+<p>Linux shared library version numbers have been added by setting SHRLIB_VERSION
+(to 6.0 in this case). So shared object will be libpvData.so.6.0 instead of
+libpvData.so.</p>
+
+<h2>Headers have been moved into pv directories</h2>
+
+<p>E.g. src/property/alarm.h -> src/property/pv/alarm.h</p>
+
+<p>This facilitates using some IDEs such as Qt Creator.</p>
+
+<h2>Requester::message has default implementation</h2>
+
+<p>Requester::message is no longer pure virtual. Default implementation sends
+string to std::cerr.</p>
+
+<h2>Serialization/deserialization helpers added</h2>
+
+<p>A helper function, serializeToVector, has been added which serializes a 
+Serializable object into a standard vector of UInt8s.</p>
+
+<p>Similarly a function deserializeFromVector deserializes a standard vector into
+a Deserializable object.</p>
+
+<p>A function deserializeFromBuffer deserializes a ByteBuffer into a 
+Deserializable object.</p>
+
+<h2>Field name validation performed</h2>
+
+<p>On creating a Structure or Union the field names are now validated.</p>
+
+<p>Valid characters for a field name are upper or lowercase letters, numbers and
+underscores and intial numbers are invalid, i.e. names must be of the form
+[A-Za-z<em>][A-Za-z0-9</em>]*.</p>
+
+<h2>Now builds for Cygwin and MinGW targets</h2>
+
+<p>Includes cross-compiling MinGW on Linux.</p>
+
+<h1>Release 5.0.4</h1>
+
+<p>The changes since release 5.0.3 are:</p>
+
+<ul>
+<li>Fixed bitset serialization (issue #24)</li>
+<li>Fixed truncation in BitSet::or_and (issue #27)</li>
+</ul>
+
+<h2>Fixed bitset serialization (issue #24)</h2>
+
+<p>C++ bitset serialization was not consistent with the C++ deserialization and
+Java code in some instances (depending on the endianness of the serializer and
+deserializer) when the number of bits was 56-63 modulo 64. C++ serialization
+has been fixed.</p>
+
+<p>Fix exposed issue in deserialization on 32-bit platforms which
+has also been corrected. </p>
+
+<h2>Fixed truncation in BitSet::or_and (issue #27)</h2>
+
+<p>If n, n1 and n2 words are used to store the values of the bitsets bitset,
+bitset1 and bitset2 respectively then max(n, min(n1,n2)) words are needed
+to store bitset.or_(bitset1, bitset2).</p>
+
+<p>Previously min(n1,n2) words were used and the result would be truncated in
+some instances. This has been fixed.</p>
+
+<h1>Release 5.0.3</h1>
+
+<p>The only change since release 5.0.2 is:</p>
+
+<h2>Fixed buffer overflow in PVUnion::serialize() (issue #20)</h2>
+
+<p>A PVUnion whose stored value was null was serialized without checking 
+whether the buffer had sufficient capacity. This has been fixed by calling
+ensureBuffer().</p>
+
+<h1>Release 5.0.2</h1>
+
+<p>The main changes since release 4.0.3 are:</p>
 
 <ul>
 <li>Deprecated getXXXField() methods have been removed from PVStructure</li>
@@ -133,7 +230,7 @@ pvData had issues due to PVStructure::DEFAULT_ID being used before being initial
 This has been changed so the it returns a null pvStructure
 and provides an error.</p>
 
-<h1>Release 4.0</h1>
+<h1>Release 4.0.3</h1>
 
 <p>The main changes since release 3.0.2 are:</p>
 

documentation/RELEASE_NOTES.md

@@ -1,7 +1,115 @@
-Release 5.0
-===========
+Release 6.0.0
+=============
 
-The main changes since release 4.0 are:
+The main changes since release 5.0.4 are:
+
+* Linux shared library version added
+* Headers have been moved into pv directories
+* Bitset functions declared const where possible
+* Bitset::swap added
+* Requester::message has default implementation
+* Serialization/deserialization helpers added
+* Non-template getSubField char* overload added
+* MonitorPlugin deprecated
+* Field name validation performed
+* Now builds for Cygwin and MinGW targets
+* Fix for debug build issue.
+* New license file replaces LICENSE and COPYRIGHT
+
+Shared library version added
+----------------------------
+
+Linux shared library version numbers have been added by setting SHRLIB_VERSION
+(to 6.0 in this case). So shared object will be libpvData.so.6.0 instead of
+libpvData.so.
+
+Headers have been moved into pv directories
+-------------------------------------------
+
+E.g. src/property/alarm.h -> src/property/pv/alarm.h
+
+This facilitates using some IDEs such as Qt Creator.
+
+Requester::message has default implementation
+---------------------------------------------
+
+Requester::message is no longer pure virtual. Default implementation sends
+string to std::cerr.
+
+Serialization/deserialization helpers added
+-------------------------------------------
+
+A helper function, serializeToVector, has been added which serializes a 
+Serializable object into a standard vector of UInt8s.
+
+Similarly a function deserializeFromVector deserializes a standard vector into
+a Deserializable object.
+
+A function deserializeFromBuffer deserializes a ByteBuffer into a 
+Deserializable object.
+
+Field name validation performed
+-------------------------------
+
+On creating a Structure or Union the field names are now validated.
+
+Valid characters for a field name are upper or lowercase letters, numbers and
+underscores and intial numbers are invalid, i.e. names must be of the form
+[A-Za-z_][A-Za-z0-9_]*.
+
+Now builds for Cygwin and MinGW targets
+---------------------------------------
+
+Includes cross-compiling MinGW on Linux.
+
+
+Release 5.0.4
+=============
+
+The changes since release 5.0.3 are:
+
+* Fixed bitset serialization (issue #24)
+* Fixed truncation in BitSet::or_and (issue #27)
+
+Fixed bitset serialization (issue #24)
+--------------------------------------
+
+C++ bitset serialization was not consistent with the C++ deserialization and
+Java code in some instances (depending on the endianness of the serializer and
+deserializer) when the number of bits was 56-63 modulo 64. C++ serialization
+has been fixed.
+
+Fix exposed issue in deserialization on 32-bit platforms which
+has also been corrected. 
+
+Fixed truncation in BitSet::or_and (issue #27)
+----------------------------------------------
+
+If n, n1 and n2 words are used to store the values of the bitsets bitset,
+bitset1 and bitset2 respectively then max(n, min(n1,n2)) words are needed
+to store bitset.or_(bitset1, bitset2).
+
+Previously min(n1,n2) words were used and the result would be truncated in
+some instances. This has been fixed.
+
+
+Release 5.0.3
+=============
+
+The only change since release 5.0.2 is:
+
+Fixed buffer overflow in PVUnion::serialize() (issue #20)
+---------------------------------------------------------
+
+A PVUnion whose stored value was null was serialized without checking 
+whether the buffer had sufficient capacity. This has been fixed by calling
+ensureBuffer().
+
+
+Release 5.0.2
+=============
+
+The main changes since release 4.0.3 are:
 
 * Deprecated getXXXField() methods have been removed from PVStructure
 * Convert copy methods and equals operators (re)moved
@@ -15,7 +123,7 @@ The main changes since release 4.0 are:
 
 
 Deprecated getXXXField methods have been removed from PVStructure
--------------------------------------------------------------------
+-----------------------------------------------------------------
 
 The following methods have been removed from PVStructure
 
@@ -141,8 +249,8 @@ This has been changed so the it returns a null pvStructure
 and provides an error.
 
 
-Release 4.0
-===========
+Release 4.0.3
+=============
 
 The main changes since release 3.0.2 are:
 

documentation/pvDataCPP.html

@@ -36,7 +36,7 @@
 <div class="head">
 <h1>EPICS pvDataCPP</h1>
 
-<h2 class="nocount">Release 5.1-DEV - 2016.03.18</h2>
+<h2 class="nocount">Release 6.0.0 - 2016.08.01</h2>
 
   <dl>
     <dt>Editors:</dt>
@@ -66,7 +66,7 @@ V4 control system programming environment:<br />
 
 <h2 class="nocount">Status of this Document</h2>
 
-<p>This is the 18-March-2016 version for the 5.1-development release of the
+<p>This is the 01-August-2016 version for the 6.0.0 release of the
 C++ implementation of pvData.
 </p>
 
@@ -4875,7 +4875,7 @@ Monitor provides:
     monitor. It, together with the queue facility, provides support for
     monitor queues.
     </dd>
-  <dt>monitorPlugin</dt>
+  <dt>monitorPlugin [Deprecated]</dt>
     <dd>This is support for implementing monitor plugins.
      A monitor plugin can be developed that has no knowledge
      of pvAccess but only pvData.
@@ -5057,7 +5057,7 @@ where
 <dl>
    <dt>monitor</dt>
      <dd>Used by code that implements pvAccess monitors.</dd>
-   <dt>monitorPlugin</dt>
+   <dt>monitorPlugin [Deprecated]</dt>
       <dd>Code that provides special semantics for monitors.</dd>
 </dl>
 <h3>monitor</h3>
@@ -5173,6 +5173,8 @@ It has the methods:</p>
 </dl>
 
 <h3>monitorPlugin</h3>
+<p>[ MonitorPlugin and related classes MonitorPluginCreator and 
+MonitorPluginManager are deprecated.]</p>
 <pre>
 class MonitorPlugin
 {

jenkins/cloudbees_build

@@ -75,4 +75,4 @@ make runtests
 ###########################################
 # Create distribution
 
-tar czf pvData.CB-dist.tar.gz lib include COPYRIGHT LICENSE
+tar czf pvData.CB-dist.tar.gz lib include LICENSE