[
https://issues.apache.org/jira/browse/CASSANDRA-2008?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12995549#comment-12995549
]
Jon Hermes commented on CASSANDRA-2008:
---------------------------------------
The problem is that it's yet another place to duplicate the config help.
There should be one and only one definition of the config options and the
sample config (conf/cassandra.yaml), the cli-help, and the wiki (and anything
else that shows up) should all point to or read from that one definition like a
bible. Adding more points of denormalization, while fine for c*, is bad for c*
code.
No matter how good the effort for this helpfile is, as new knobs and buttons
get added to the config, it will suffer rot.
Putting it in YAML wouldn't be my first choice as YAML is slowly getting
deprecated, but that would suffice to make it parseable by the CLI and readable
by the sample config at the same time.
-
Aside from the strategy for this bug, that help text looks pretty clean. I'd be
sure to separate "required" from "optional/defaulted" (and give the defaults
for these in a consistent way), and to sort the options. (The wiki sorts them
alphabetically and groups them by related config, for example, and still not
sure if that's ideal.)
> CLI help incorrect in places
> ----------------------------
>
> Key: CASSANDRA-2008
> URL: https://issues.apache.org/jira/browse/CASSANDRA-2008
> Project: Cassandra
> Issue Type: Improvement
> Components: Core
> Affects Versions: 0.7.0
> Reporter: Aaron Morton
> Assignee: Aaron Morton
> Priority: Trivial
> Fix For: 0.7.2
>
>
> Found some errors in the CLI help, such as these for create column family.
> - memtable_operations: Flush memtables after this many operations
> - memtable_throughput: ... or after this many bytes have been written
> - memtable_flush_after: ... or after this many seconds
> Should be millions of ops, MB's written and minutes not seconds. Have
> confirmed thats how the values are used. Will check all the help.
--
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
