From: Ben Pfaff <blp@nicira.com>
Date: Wed, 30 Jun 2010 21:35:02 +0000 (-0700)
Subject: ovsdb: Document in SPECS how OVS uses JSON.
X-Git-Tag: v1.1.0pre1~202
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=65e18fa85dde840da4a9cb956cf7bb2c0fc1d95c;p=sliver-openvswitch.git

ovsdb: Document in SPECS how OVS uses JSON.

CC: Jeremy Stribling <strib@nicira.com>
---

diff --git a/ovsdb/SPECS b/ovsdb/SPECS
index cbd69defc..524e52f31 100644
--- a/ovsdb/SPECS
+++ b/ovsdb/SPECS
@@ -5,6 +5,19 @@
 Basic Notation
 --------------
 
+OVSDB uses JSON, as defined by RFC 4627, for its schema format and its
+wire protocol format.  The JSON implementation in Open vSwitch has the
+following limitations:
+
+     - Null bytes (\u0000) are not allowed in strings.
+
+     - Only UTF-8 encoding is supported.  (RFC 4627 also mentions
+       UTF-16BE, UTF-16LE, and UTF-32.)
+
+     - RFC 4627 says that names within a JSON object should be unique.
+       The Open vSwitch JSON parser discards all but the last value
+       for a name that is specified more than once.
+
 The descriptions below use the following shorthand notations for JSON
 values.  Additional notation is presented later.