[uima-uimaj] branch master updated: [UIMA-6162] document some CAS serialization are synchronized

[sc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

schor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/uima-uimaj.git


The following commit(s) were added to refs/heads/master by this push:
     new 382b096  [UIMA-6162] document some CAS serialization are synchronized
382b096 is described below

commit 382b096ae3967af6fa6fd6758fd36ae427372c6a
Author: Marshall Schor <ms...@schor.com>
AuthorDate: Thu Dec 19 14:47:41 2019 -0500

    [UIMA-6162] document some CAS serialization are synchronized
    
    for operations that make use of data structures for building serialized
    forms that are part of the CAS's svd.
---
 .../src/docbook/tug.application.xml                                 | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml b/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
index 072aa11..42a12ed 100644
--- a/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
+++ b/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
@@ -728,7 +728,11 @@ ae.destroy();</programlisting></para>
       See the Javadocs for that class for details.</para>
       
       <para>Several of the APIs use or return instances of <code>SerialFormat</code>, which is an enum specifying the various
-      forms of serialization.</para>  
+      forms of serialization.</para>
+      
+      <para>Serialization often makes use of temporary extra data structures, anchored from the CAS being serialized.
+        These are read/write, and because of this, most serializations are synchronized to prevent multiple
+        serializations of the same CAS from happening in parallel.</para>  
     </section>
   </section>