[
https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745228#action_12745228
]
Eric Evans commented on CASSANDRA-373:
--------------------------------------
> The tilde's at the beginning of the comment lines impair reading.
Ok. The intention was to make it more readable by marking the left-most margin
of the comment block. I did this with a tilde only because that was already in
use for the copyright header, and I thought that looked ok. Suggestions welcome.
> * CommitLogSyncDelay : "in millis" but other elements have the InFoo
> quantity pattern. Inconsistent.
>
> * MemtableObjectCountInMillions: asking people to type in floats is error
> prone, why not MemtableObjectCount?
>
> * CommitLogSync: doesn't document its legal values
>
> * Thrift*: should be wrapped in an holding element. Because, and I'm guessing
> here, Thrift will not remain the only, or even the default, transport/api.
>
> * InitialToken: doesn't document what happens when empty
>
> * Seed, ListenAddress, ThriftAddress: don't document whether they take Ipv6
> addresses
I had intended the scope of this ticket to be formatting/styling. Could you
open a separate ticket for these?
> storage-conf.xml reformatting
> -----------------------------
>
> Key: CASSANDRA-373
> URL: https://issues.apache.org/jira/browse/CASSANDRA-373
> Project: Cassandra
> Issue Type: Bug
> Reporter: Eric Evans
> Assignee: Eric Evans
> Attachments:
> v1-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt,
> v2-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt,
> v3-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt
>
>
> Our sample config (conf/storage-conf.xml) is the canonical source of
> configuration documentation. As such readability should be a priority, and it
> should serve as the best possible basis for customization.
> I propose the following:
> 1. Wherever possible, lines should wrap at 75 chars. The file will be edited
> post-installation by operational personnel, who are often confined to
> standard 80 character terminals.
> 2. Indention of 2 spaces to make maximum use of horizontal real estate.
> 3. More distinctive multi-line comments.
> 4. Path locations that conform to the FHS.
> Patch to follow...
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
