feature #1362: print column description with --describe

src/cli/cli_helper.rb

@@ -158,6 +158,14 @@ module CLIHelper
             end
         end
 
+        def describe_columns
+            str="%-20s: %-20s"
+
+            @columns.each do |column, d|
+                puts str % [column, d[:desc]]
+            end
+        end
+
         private
 
         def print_table(data, options)

src/cli/one_helper.rb

@@ -61,6 +61,12 @@ EOT
         :description => "Show units in kilobytes"
     }
 
+    DESCRIBE={
+        :name  => "describe",
+        :large => "--describe",
+        :description => "Describe list columns"
+    }
+
     OPTIONS = XML, NUMERIC, KILOBYTES
 
     class OneHelper
@@ -88,6 +94,13 @@ EOT
         end
 
         def list_pool(options, top=false, filter_flag=nil)
+            if options[:describe]
+                table = format_pool(options)
+
+                table.describe_columns
+                return 0
+            end
+
             filter_flag ||= OpenNebula::Pool::INFO_ALL
 
             pool = factory_pool(filter_flag)

src/cli/oneacl

@@ -90,7 +90,8 @@ cmd = CommandParser::CmdParser.new(ARGV) do
         Lists the ACL rule set
     EOT
 
-    command :list, list_desc,:options=>OpenNebulaHelper::XML do
+    command :list, list_desc,:options=>[OpenNebulaHelper::XML,
+            OpenNebulaHelper::DESCRIBE] do
         helper.list_pool( options )
     end
 end

src/cli/onecluster

@@ -44,6 +44,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     ########################################################################
     # Formatters for arguments

src/cli/onedatastore

@@ -45,6 +45,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     ########################################################################
     # Formatters for arguments

src/cli/onegroup

@@ -44,6 +44,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     ########################################################################
     # Formatters for arguments

src/cli/onehost

@@ -170,7 +170,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :list, list_desc,
-            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS do
+            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS+
+            [OpenNebulaHelper::DESCRIBE] do
         helper.list_pool(options)
     end
 

src/cli/oneimage

@@ -45,6 +45,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     CREATE_OPTIONS = [OneDatastoreHelper::DATASTORE]
 

src/cli/onetemplate

@@ -44,6 +44,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     instantiate_options = [
         OneTemplateHelper::VM_NAME,

src/cli/oneuser

@@ -45,6 +45,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
     list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
 
     READ_FILE={
         :name => "read_file",

src/cli/onevm

@@ -468,7 +468,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :list, list_desc, [:filterflag, nil],
-            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS do
+            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS+
+            [OpenNebulaHelper::DESCRIBE] do
         helper.list_pool(options, false, args[0])
     end
 

src/cli/onevnet

@@ -199,7 +199,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :list, list_desc, [:filterflag, nil],
-            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS do
+            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS+
+            [OpenNebulaHelper::DESCRIBE] do
         helper.list_pool(options, false, args[0])
     end