You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2010/07/18 07:15:43 UTC

svn commit: r965158 - in /hbase/trunk: CHANGES.txt src/main/ruby/shell.rb

Author: stack
Date: Sun Jul 18 05:15:43 2010
New Revision: 965158

URL: http://svn.apache.org/viewvc?rev=965158&view=rev
Log:
HBASE-2845 Small edit of shell main help page cutting down some on white space and text

Modified:
    hbase/trunk/CHANGES.txt
    hbase/trunk/src/main/ruby/shell.rb

Modified: hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hbase/trunk/CHANGES.txt?rev=965158&r1=965157&r2=965158&view=diff
==============================================================================
--- hbase/trunk/CHANGES.txt (original)
+++ hbase/trunk/CHANGES.txt Sun Jul 18 05:15:43 2010
@@ -776,7 +776,9 @@ Release 0.21.0 - Unreleased
    HBASE-2835  Update hadoop jar to head of branch-0.20-append to catch three
                added patches
    HBASE-2840  Remove the final remnants of the old Get code - the query matchers 
-   	       and other helper classes
+               and other helper classes
+   HBASE-2845  Small edit of shell main help page cutting down some on white
+               space and text
 
   NEW FEATURES
    HBASE-1961  HBase EC2 scripts

Modified: hbase/trunk/src/main/ruby/shell.rb
URL: http://svn.apache.org/viewvc/hbase/trunk/src/main/ruby/shell.rb?rev=965158&r1=965157&r2=965158&view=diff
==============================================================================
--- hbase/trunk/src/main/ruby/shell.rb (original)
+++ hbase/trunk/src/main/ruby/shell.rb Sun Jul 18 05:15:43 2010
@@ -143,8 +143,6 @@ module Shell
       puts
       puts '-' * 80
       puts
-      puts "Here is the list of groups with their commands:"
-      puts
       ::Shell.command_groups.each do |name, group|
         puts "  " + group[:full_name] + ": "
         puts "    group name: " + name
@@ -162,39 +160,33 @@ module Shell
     end
 
     def help_header
-      return "There are few groups of commands in HBase\n\n" +
-             "Use help 'group_name' (e.g. help 'general') to get help on all commands in a group\n" +
-             "Use help 'command' (e.g. help 'get') to get help on a specific command"
+      return "Enter, help 'COMMAND_GROUP', (e.g. help 'general') to get help on all commands in a group\n" +
+             "Enter, help 'COMMAND', (e.g. help 'get') to get help on a specific command"
     end
 
     def help_footer
-      puts "GENERAL NOTES:"
       puts <<-HERE
-        Quote all names in the hbase shell such as table and column names.  Don't
-        forget commas delimit command parameters.  Type <RETURN> after entering a
-        command to run it.  Dictionaries of configuration used in the creation
-        and alteration of tables are ruby Hashes. They look like this:
-
-          {'key1' => 'value1', 'key2' => 'value2', ...}
-
-        They are opened and closed with curley-braces.  Key/values are delimited
-        by the '=>' character combination.  Usually keys are predefined constants
-        such as NAME, VERSIONS, COMPRESSION, etc.  Constants do not need to be
-        quoted.  Type 'Object.constants' to see a (messy) list of all constants
-        in the environment.
-
-        In case you are using binary keys or values and need to enter them into
-        the shell then use double-quotes to make use of hexadecimal for example:
-
-          hbase> get 't1', "key\\x03\\x3f\\xcd"
-          hbase> get 't1', "key\\003\\023\\011"
-          hbase> put 't1', "test\\xef\\xff", 'f1:', "\\x01\\x33\\x40"
-
-        Using the double-quote notation you can directly use the values output by
-        the shell for example during a "scan" call.
+Quote all names in HBase shell such as table and column names.  Commas delimit
+command parameters.  Type <RETURN> after entering a command to run it.
+Dictionaries of configuration used in the creation and alteration of tables are
+Ruby Hashes. They look like this:
+
+  {'key1' => 'value1', 'key2' => 'value2', ...}
+
+and are opened and closed with curley-braces.  Key/values are delimited by the
+'=>' character combination.  Usually keys are predefined constants such as
+NAME, VERSIONS, COMPRESSION, etc.  Constants do not need to be quoted.  Type
+'Object.constants' to see a (messy) list of all constants in the environment.
+
+If you are using binary keys or values and need to enter them in the shell, use
+double-quote'd hexadecimal representation. For example:
+
+  hbase> get 't1', "key\\x03\\x3f\\xcd"
+  hbase> get 't1', "key\\003\\023\\011"
+  hbase> put 't1', "test\\xef\\xff", 'f1:', "\\x01\\x33\\x40"
 
-        This HBase shell is the JRuby IRB with the above HBase-specific commands
-        added.  For more on the HBase Shell, see http://wiki.apache.org/hadoop/Hbase/Shell
+The HBase shell is the (J)Ruby IRB with the above HBase-specific commands added.
+For more on the HBase Shell, see http://wiki.apache.org/hadoop/Hbase/Shell
       HERE
     end
   end