[ZOOKEEPER-1786] ZooKeeper data model documentation is incorrect

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.4.6
• Fix Version/s: 3.4.6, 3.5.0
• Component/s: documentation
• Assignee: Niraj Tolia
• Reporter: Niraj Tolia
• Created: 09/Oct/13 08:10
• Updated: 13/Mar/14 18:16
• Resolved: 15/Nov/13 18:07

Description

When I look at https://zookeeper.apache.org/doc/trunk/zookeeperProgrammers.html#ch_zkDataModel, I see two things that seem wrong in terms of restricted characters:

• \uXFFFE - \uXFFFF (where X is a digit 1 - E)
• \uF0000 - \uFFFFF

These definitions are invalid characters in Java and aren't reflected in PathUtils either (or PathUtilsTest). In fact the code in PathUtils states:

            } else if (c > '\u0000' && c <= '\u001f'
                    || c >= '\u007f' && c <= '\u009F'
                    || c >= '\ud800' && c <= '\uf8ff'
                    || c >= '\ufff0' && c <= '\uffff') {
                reason = "invalid charater @" + i;
                break;
            }

Unless I am missing something, this simple patch should fix the documentation problem:

Index: src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml
===================================================================
--- src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml	(revision 1530514)
+++ src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml	(working copy)
@@ -139,8 +139,7 @@

       <listitem>
         <para>The following characters are not allowed: \ud800 - uF8FF,
-        \uFFF0 - uFFFF, \uXFFFE - \uXFFFF (where X is a digit 1 - E), \uF0000 -
-        \uFFFFF.</para>
+        \uFFF0 - uFFFF.</para>
       </listitem>

       <listitem>