Mailing-List: contact commits-help@cassandra.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cassandra.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1177813 - in /cassandra/branches/cassandra-1.0.0:
 CHANGES.txt
 src/resources/org/apache/cassandra/cli/CliHelp.yaml
Date: Fri, 30 Sep 2011 20:20:23 -0000
To: commits@cassandra.apache.org
From: xedin@apache.org
Message-Id: <20110930202024.11C73238897D@eris.apache.org>

Author: xedin
Date: Fri Sep 30 20:20:23 2011
New Revision: 1177813

URL: http://svn.apache.org/viewvc?rev=1177813&view=rev
Log:
CLI documentation change for ColumnFamily `compression_options`
patch by Pavel Yaskevich; reviewed by Brandon Williams for CASSANDRA-3282

Modified:
    cassandra/branches/cassandra-1.0.0/CHANGES.txt
    cassandra/branches/cassandra-1.0.0/src/resources/org/apache/cassandra/cli/CliHelp.yaml

Modified: cassandra/branches/cassandra-1.0.0/CHANGES.txt
URL: http://svn.apache.org/viewvc/cassandra/branches/cassandra-1.0.0/CHANGES.txt?rev=1177813&r1=1177812&r2=1177813&view=diff
==============================================================================
--- cassandra/branches/cassandra-1.0.0/CHANGES.txt (original)
+++ cassandra/branches/cassandra-1.0.0/CHANGES.txt Fri Sep 30 20:20:23 2011
@@ -11,7 +11,7 @@
  * fix counter entry in jdbc TypesMap (CASSANDRA-3268)
  * fix full queue scenario for ParallelCompactionIterator (CASSANDRA-3270)
  * fix bootstrap process (CASSANDRA-3285)
-
+ * CLI documentation change for ColumnFamily `compression_options` (CASSANDRA-3282)
 
 1.0.0-rc1
  * Update CQL to generate microsecond timestamps by default (CASSANDRA-3227)

Modified: cassandra/branches/cassandra-1.0.0/src/resources/org/apache/cassandra/cli/CliHelp.yaml
URL: http://svn.apache.org/viewvc/cassandra/branches/cassandra-1.0.0/src/resources/org/apache/cassandra/cli/CliHelp.yaml?rev=1177813&r1=1177812&r2=1177813&view=diff
==============================================================================
--- cassandra/branches/cassandra-1.0.0/src/resources/org/apache/cassandra/cli/CliHelp.yaml (original)
+++ cassandra/branches/cassandra-1.0.0/src/resources/org/apache/cassandra/cli/CliHelp.yaml Fri Sep 30 20:20:23 2011
@@ -563,25 +563,20 @@ commands:
         more rows in a given memory footprint.  And storing the cache off-heap
         means you can use smaller heap sizes, reducing the impact of GC pauses.
 
-        - compression: Use compression for SSTable data files.
-
-        Supported values are:
-            - null: to disable compression
-            - SnappyCompressor: compression based on the Snappy algorithm
-            - DeflateCompressor: compression based on the deflate algorithm
-            (through Java native support)
+        - compression_options: Options related to compression.
+          Options have the form {key:value}.
+          The main recognized options are:
+            - sstable_compression: the algorithm to use to compress sstables for
+              this column family. If none is provided, compression will not be
+              enabled. Supported values are SnappyCompressor, DeflateCompressor or
+              any custom compressor. It is also valid to specify the fully-qualified
+              class name to a class that implements org.apache.cassandra.io.ICompressor.
 
-        It is also valid to specify the fully-qualified class name to a class
-        that implements org.apache.cassandra.io.ICompressor.
+            - chunk_length_kb: specify the size of the chunk used by sstable
+              compression (default to 64, must be a power of 2).
 
-        - compression_options: Options related to compression.
-          Options have the form [{key:value}]. The main recognized option are:
-          - sstable_compression: the algorithm to use to compress sstables for
-          this column family. If none is provided, compression will not be
-          enabled. Supported values are SnappyCompressor, DeflateCompressor or
-          any custom compressor.
-          - chunk_length_kb: specify the size of the chunk used by sstable
-          compression (default to 64, must be a power of 2).
+          To disable compression just set compression_options to null like this
+          `compression_options = null`.
 
         Examples:
         create column family Super4
@@ -836,7 +831,20 @@ commands:
         memory footprint.  And storing the cache off-heap means you
         can use smaller heap sizes, reducing the impact of GC pauses.
 
-        - compression: Use compression for SSTable data files. Accepts the values true and false.
+        - compression_options: Options related to compression.
+          Options have the form {key:value}.
+          The main recognized options are:
+            - sstable_compression: the algorithm to use to compress sstables for
+              this column family. If none is provided, compression will not be
+              enabled. Supported values are SnappyCompressor, DeflateCompressor or
+              any custom compressor. It is also valid to specify the fully-qualified
+              class name to a class that implements org.apache.cassandra.io.ICompressor.
+
+            - chunk_length_kb: specify the size of the chunk used by sstable
+              compression (default to 64, must be a power of 2).
+
+          To disable compression just set compression_options to null like this
+          `compression_options = null`.
 
         Examples:
         update column family Super4