svn commit: r900565 - in /hadoop/avro/trunk: CHANGES.txt doc/src/content/xdocs/spec.xml

[cu...@apache.org]

Author: cutting
Date: Mon Jan 18 21:17:56 2010
New Revision: 900565

URL: http://svn.apache.org/viewvc?rev=900565&view=rev
Log:
AVRO-198. Fix error in specification of protocol name, also clarify which properties are required.

Modified:
    hadoop/avro/trunk/CHANGES.txt
    hadoop/avro/trunk/doc/src/content/xdocs/spec.xml

Modified: hadoop/avro/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/CHANGES.txt?rev=900565&r1=900564&r2=900565&view=diff
==============================================================================
--- hadoop/avro/trunk/CHANGES.txt (original)
+++ hadoop/avro/trunk/CHANGES.txt Mon Jan 18 21:17:56 2010
@@ -221,6 +221,9 @@
 
     AVRO-243. Use automake generated Makefile.in (sbanacho)
 
+    AVRO-198. Fix specification of protocol name, also clarify which
+    properties are required.  (cutting)
+
   OPTIMIZATIONS
 
     AVRO-172. More efficient schema processing (massie)

Modified: hadoop/avro/trunk/doc/src/content/xdocs/spec.xml
URL: http://svn.apache.org/viewvc/hadoop/avro/trunk/doc/src/content/xdocs/spec.xml?rev=900565&r1=900564&r2=900565&view=diff
==============================================================================
--- hadoop/avro/trunk/doc/src/content/xdocs/spec.xml (original)
+++ hadoop/avro/trunk/doc/src/content/xdocs/spec.xml Mon Jan 18 21:17:56 2010
@@ -658,17 +658,19 @@
 
       <p>A protocol is a JSON object with the following attributes:</p>
       <ul>
-	<li><em>name</em>, string, to distinguish it from other protocols;</li>
-	<li><em>namespace</em>, a string that qualifies the name;</li>
-	<li><em>doc</em>, an optional string, describing this protocol;</li>
-	<li><em>types</em>, a list of definitions of named types
+	<li><em>protocol</em>, a string, the name of the protocol
+	(required);</li>
+	<li><em>namespace</em>, an optional string that qualifies the name;</li>
+	<li><em>doc</em>, an optional string describing this protocol;</li>
+	<li><em>types</em>, an optional list of definitions of named types
 	  (records, enums, fixed and errors).  An error definition is
 	  just like a record definition except it uses "error" instead
 	  of "record".  Note that forward references to named types
 	  are not permitted.</li>
-	<li><em>messages</em>, a JSON object whose keys are message
-	  names and whose values are objects whose attributes are
-	  described below.  No two messages may have the same name.</li>
+	<li><em>messages</em>, an optional JSON object whose keys are
+	  message names and whose values are objects whose attributes
+	  are described below.  No two messages may have the same
+	  name.</li>
       </ul>
 
       <section>