[jira] [Resolved] (ZOOKEEPER-1786) ZooKeeper data model documentation is incorrect

["Flavio Junqueira (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/ZOOKEEPER-1786?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Flavio Junqueira resolved ZOOKEEPER-1786.
-----------------------------------------

    Resolution: Fixed

Trunk Committed revision 1542355.

> ZooKeeper data model documentation is incorrect
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-1786
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-1786
>             Project: ZooKeeper
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 3.4.6
>            Reporter: Niraj Tolia
>            Priority: Minor
>             Fix For: 3.4.6, 3.5.0
>
>         Attachments: ZOOKEEPER-1786.patch
>
>
> 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:
> {code:borderStyle=solid}
>             } else if (c > '\u0000' && c <= '\u001f'
>                     || c >= '\u007f' && c <= '\u009F'
>                     || c >= '\ud800' && c <= '\uf8ff'
>                     || c >= '\ufff0' && c <= '\uffff') {
>                 reason = "invalid charater @" + i;
>                 break;
>             }
> {code}
> Unless I am missing something, this simple patch should fix the documentation problem:
> {code}
> 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>
> {code}



--
This message was sent by Atlassian JIRA
(v6.1#6144)