You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by "Eric Evans (JIRA)" <ji...@apache.org> on 2009/08/18 20:36:14 UTC
[jira] Created: (CASSANDRA-373) storage-conf.xml reformatting
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
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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Michael Greene (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12744672#action_12744672 ]
Michael Greene commented on CASSANDRA-373:
------------------------------------------
In general, looks good. While reviewing, noticed an existing internal conflict between microseconds and milliseconds for CommitLogSyncBatchWindowInMS that should be corrected.
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745215#action_12745215 ]
Eric Evans commented on CASSANDRA-373:
--------------------------------------
>Who seriously uses a vt100 rather than remoting in these days? You can always use a larger terminal and/or an editor that handles wrapped lines sanely.
You have to wrap somewhere; the point of 80 chars is that it is the minimum you could expect to see in use.
This is pretty much best practice among projects with hand edited configuration files. A quick survey of the files under /etc on any *nix box should confirm this.
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745242#action_12745242 ]
Jonathan Ellis commented on CASSANDRA-373:
------------------------------------------
Can we at least wrap things symmetrically?
<ColumnFamily ColumnType="Super"
CompareWith="UTF8Type"
CompareSubcolumnsWith="UTF8Type"
Name="Super1"/>
instead of
+ <ColumnFamily ColumnType="Super" CompareWith="UTF8Type"
+ CompareSubcolumnsWith="UTF8Type" Name="Super1"/>
> 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
> Fix For: 0.4
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Bill de hOra (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745204#action_12745204 ]
Bill de hOra commented on CASSANDRA-373:
----------------------------------------
{quote}
That's the lesser of evils compared to out-of-date documentation of the options.
{quote}
Agreed!
> 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
>
>
> 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.
[jira] Issue Comment Edited: (CASSANDRA-373) storage-conf.xml
reformatting
Posted by "Bill de hOra (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745193#action_12745193 ]
Bill de hOra edited comment on CASSANDRA-373 at 8/19/09 1:54 PM:
-----------------------------------------------------------------
{quote}
1. Wherever possible, lines should wrap at 75 chars.
{quote}
is this not best done by reducing the comment noise?
Also verbose comments tend to be annoying in practice operationally - hey get in the way of the the actual elements you need to set/read when you need to see/read them on a console - tomcat is an example offender and a system i'm tired of stripping comments from.
{quote}
4. Path locations that conform to the FHS.
{quote}
Not for us to mandate surely.
* The tilde's at the beginning of the comment lines impair reading.
* I don't like putting advice or good rules of thumb in the config - would we do this kind of thing in the thrift?
* 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
was (Author: dehora):
{quote}
1. Wherever possible, lines should wrap at 75 chars.
{quote}
is this not best done by reducing the comment noise?
Also verbose comments tend to be annoying in practice operationally - hey get in the way of the the actual elements you need to set/read when you need to see/read them on a console - tomcat is example offender and a system i'm tired of stripping comments from.
{quote}
4. Path locations that conform to the FHS.
{quote}
Not for us to mandate surely.
* The tilde's at the beginning of the comment lines impair reading.
* I don't like putting advice or good rules of thumb in the config - would we do this kind of thing in the thrift?
* 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
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745194#action_12745194 ]
Jonathan Ellis commented on CASSANDRA-373:
------------------------------------------
> 1. Wherever possible, lines should wrap at 75 chars.
Who seriously uses a vt100 rather than remoting in these days? You can always use a larger terminal and/or an editor that handles wrapped lines sanely.
> 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
>
>
> 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.
[jira] Updated: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eric Evans updated CASSANDRA-373:
---------------------------------
Attachment: v3-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745738#action_12745738 ]
Jonathan Ellis commented on CASSANDRA-373:
------------------------------------------
> remove the verbose comments
not going to happen. see above re lesser of evils.
> and the leading tildes
if you have a better suggestion, you are welcome to submit a patch -- Eric said above that he was open to suggestions to improve this but none were forthcoming.
> All I'm going to do with them is strip them out.
That's fine, but because you don't need them doesn't mean they are not useful for others.
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745287#action_12745287 ]
Jonathan Ellis commented on CASSANDRA-373:
------------------------------------------
+1
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Updated: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Ellis updated CASSANDRA-373:
-------------------------------------
Fix Version/s: 0.4
> 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
> Fix For: 0.4
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745226#action_12745226 ]
Eric Evans commented on CASSANDRA-373:
--------------------------------------
v3-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt brings the file up-to-date with the commitlog options in trunk.
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Michael Greene (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745289#action_12745289 ]
Michael Greene commented on CASSANDRA-373:
------------------------------------------
Still says 'microseconds' but +1 if microseconds is changed to milliseconds for the commit log batch delay
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Jonathan Ellis (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745195#action_12745195 ]
Jonathan Ellis commented on CASSANDRA-373:
------------------------------------------
> verbose comments tend to be annoying in practice operationally
That's the lesser of evils compared to out-of-date documentation of the options.
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Hudson (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745938#action_12745938 ]
Hudson commented on CASSANDRA-373:
----------------------------------
Integrated in Cassandra #174 (See [http://hudson.zones.apache.org/hudson/job/Cassandra/174/])
re{format,factor} conf/storage-conf.xml
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Bill de hOra (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745734#action_12745734 ]
Bill de hOra commented on CASSANDRA-373:
----------------------------------------
Please revert this and remove the verbose comments and the leading tildes. All I'm going to do with them is strip them out.
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Updated: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eric Evans updated CASSANDRA-373:
---------------------------------
Attachment: v1-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745284#action_12745284 ]
Eric Evans commented on CASSANDRA-373:
--------------------------------------
> Can we at least wrap things symmetrically?
Sure. See v4 patch.
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12744645#action_12744645 ]
Eric Evans commented on CASSANDRA-373:
--------------------------------------
whoops, v1 had an error, see v2 instead.
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Michael Greene (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745222#action_12745222 ]
Michael Greene commented on CASSANDRA-373:
------------------------------------------
There are a few errors in the CommitLog area that Eric and I discussed on IRC that will need to be fixed (including the legal values Bill mentions).
The path locations are just examples -- we have to choose something to default to, and the best thing to default to would be a common standard. Users are still, of course, able to specify whatever writable paths they desire.
> 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
>
>
> 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.
[jira] Updated: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eric Evans updated CASSANDRA-373:
---------------------------------
Attachment: v4-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt
> 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
> Fix For: 0.4
>
> 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, v4-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.
[jira] Updated: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Eric Evans (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Eric Evans updated CASSANDRA-373:
---------------------------------
Attachment: v2-0001-CASSANDRA-373-re-format-factor-conf-storage-conf.xml.txt
> 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
>
>
> 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.
[jira] Commented: (CASSANDRA-373) storage-conf.xml reformatting
Posted by "Bill de hOra (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CASSANDRA-373?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745193#action_12745193 ]
Bill de hOra commented on CASSANDRA-373:
----------------------------------------
{quote}
1. Wherever possible, lines should wrap at 75 chars.
{quote}
is this not best done by reducing the comment noise?
Also verbose comments tend to be annoying in practice operationally - hey get in the way of the the actual elements you need to set/read when you need to see/read them on a console - tomcat is example offender and a system i'm tired of stripping comments from.
{quote}
4. Path locations that conform to the FHS.
{quote}
Not for us to mandate surely.
* The tilde's at the beginning of the comment lines impair reading.
* I don't like putting advice or good rules of thumb in the config - would we do this kind of thing in the thrift?
* 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
> 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
>
>
> 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.