Groonga - fulltext search engine.

[Groonga-commit] droonga/droonga-client-ruby at c5b86be [master] Use more meaningful descriptions for each option

YUKI Hiroshi null+****@clear*****
Thu May 7 12:23:36 JST 2015

• Previous message: [Groonga-commit] groonga/grnxx at 0fbc959 [master] Gnx: rename functions for tests.
• Next message: [Groonga-commit] droonga/droonga-client-ruby at 7a2440f [master] Delete "--receiver-port" option of droonga-request.
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

YUKI Hiroshi	2015-05-07 12:23:36 +0900 (Thu, 07 May 2015)

  New Revision: c5b86be737af590d6bded6b34bbf03398e03b967
  https://github.com/droonga/droonga-client-ruby/commit/c5b86be737af590d6bded6b34bbf03398e03b967

  Message:
    Use more meaningful descriptions for each option

  Modified files:
    bin/droonga-request
    bin/droonga-send

  Modified: bin/droonga-request (+11 -11)
===================================================================
--- bin/droonga-request    2015-05-07 12:01:07 +0900 (162c8dd)
+++ bin/droonga-request    2015-05-07 12:23:36 +0900 (1f5b4f3)
@@ -44,23 +44,23 @@ parser.banner += " REQUEST_JSON_FILE"
 parser.separator("")
 parser.separator("Connect:")
 parser.on("--host=HOST",
-          "Host name of the engine node.",
+          "Host name of the endpoint to communicate with the Droonga cluster.",
           "(#{options[:host]})") do |host|
   options[:host] = host
 end
 parser.on("--port=PORT", Integer,
-          "Port number to communicate with the engine.",
+          "Port number to communicate with the endpoint of the Droonga cluster.",
           "(#{options[:port]})") do |port|
   options[:port] = port
 end
 parser.on("--tag=TAG",
-          "Tag name to communicate with the engine.",
+          "Tag name to communicate with the endpoint of the Droonga cluster.",
           "(#{options[:tag]})") do |tag|
   options[:tag] = tag
 end
 available_protocols = [:droonga, :http]
 parser.on("--protocol=PROTOCOL", available_protocols,
-          "Protocol to be used to communicate with Droonga system.",
+          "Protocol to communicate with the endpoint of the Droonga cluster.",
           "[#{available_protocols.join('|')}]",
           "(#{options[:protocol]})") do |protocol|
   options[:protocol] = protocol
@@ -80,7 +80,7 @@ end
 parser.separator("")
 parser.separator("Droonga protocol:")
 parser.on("--receiver-host=HOST",
-          "Host name to be received a response from Droonga engine.",
+          "Host name of the computer you are running this command.",
           "(#{options[:receiver_host]})") do |host|
   options[:receiver_host] = host
 end
@@ -92,34 +92,34 @@ end
 parser.separator("")
 parser.separator("Report:")
 parser.on("--[no-]report-request",
-          "Reports request message.",
+          "Reports request messages actually sent.",
           "(#{options[:report_request]})") do |report_request|
   options[:report_request] = report_request
 end
 parser.on("--[no-]report-elapsed-time",
-          "Reports elapsed time.",
+          "Reports elapsed time between a request and a response.",
           "(#{options[:report_elapsed_time]})") do |report_elapsed_time|
   options[:report_elapsed_time] = report_elapsed_time
 end
 parser.separator("")
 parser.separator("Messages:")
 parser.on("--detault-dataset=NAME",
-          "Default dataset name for the sending message.",
+          "Default dataset name for sending messages.",
           "(#{options[:default_dataset]})") do |name|
   options[:default_dataset] = name
 end
 parser.on("--detault-target-role=ROLE",
-          "Default role of engine nodes which should process the message.",
+          "Default role of engine nodes which should process messages.",
           "(#{options[:default_target_role]})") do |role|
   options[:default_target_role] = role
 end
 parser.on("--[no-]completion",
-          "Do completion of required fields for input message or not.",
+          "Do completion of required fields for input messages or not.",
           "(#{options[:completion]})") do |completion|
   options[:completion] = completion
 end
 parser.on("--[no-]validation",
-          "Do validation for input message or not.",
+          "Do validation for input messages or not.",
           "(#{options[:validation]})") do |validation|
   options[:validation] = validation
 end

  Modified: bin/droonga-send (+12 -12)
===================================================================
--- bin/droonga-send    2015-05-07 12:01:07 +0900 (f747217)
+++ bin/droonga-send    2015-05-07 12:23:36 +0900 (23d4182)
@@ -115,57 +115,57 @@ parser.on("--server=PROTOCOL:HOST:PORT/TAG",
   servers << server
 end
 parser.on("--messages-per-second=N", Integer,
-          "Apply rate limitation by N messages/second.",
-          "'#{Droonga::Client::RateLimiter::NO_LIMIT}' means no limit.",
+          "Maximum number of messages to be sent in a second.",
+          "'#{Droonga::Client::RateLimiter::NO_LIMIT}' means \"no limit\".",
           "(#{messages_per_second})") do |n|
   messages_per_second = n
 end
 parser.on("--default-protocol=PROTOCOL",
-          "Default protocol for servers.",
+          "Default protocol to communicate with endpoints of the Droonga cluster.",
           "(#{options.default_protocol})") do |protocol|
   options.default_protocol = protocol
 end
 parser.on("--default-port=PORT", Integer,
-          "Default port number to communicate with the engine.",
+          "Default port number to communicate with endpoints of the Droonga cluster.",
           "(#{options.default_port})") do |port|
   options.default_port = port
 end
 parser.on("--default-tag=TAG",
-          "Default tag name to communicate with the engine.",
+          "Default tag name to communicate with the endpoints of the Droonga cluster.",
           "(#{options.default_tag})") do |tag|
   options.default_tag = tag
 end
 parser.separator("")
 parser.separator("Report:")
 parser.on("--[no-]report-request",
-          "Reports request message.",
+          "Reports request messages.",
           "(#{options.report_request})") do |report_request|
   options.report_request = report_request
 end
-parser.on("--report-throughput",
+parser.on("--[no-]report-throughput",
           "Reports throughput by messages per second.",
-          "(no)") do
+          "(#{options.report_throughput})") do
   options.report_throughput = true
 end
 parser.separator("")
 parser.separator("Messages:")
 parser.on("--default-dataset=NAME",
-          "Default dataset name for the sending message.",
+          "Default dataset name for sending messages.",
           "(#{options.default_dataset})") do |name|
   options.default_dataset = name
 end
 parser.on("--default-target-role=ROLE",
-          "Default role of engine nodes which should process the message.",
+          "Default role of engine nodes which should process messages.",
           "(#{options.default_target_role})") do |role|
   options.default_target_role = role
 end
 parser.on("--[no-]completion",
-          "Do completion of required fields for input message or not.",
+          "Do completion of required fields for input messages or not.",
           "(#{options.completion})") do |completion|
   options.completion = completion
 end
 parser.on("--[no-]validation",
-          "Do validation for input message or not.",
+          "Do validation for input messages or not.",
           "(#{options.validation})") do |validation|
   options.validation = validation
 end
-------------- next part --------------
HTML����������������������������...
Download 

• Previous message: [Groonga-commit] groonga/grnxx at 0fbc959 [master] Gnx: rename functions for tests.
• Next message: [Groonga-commit] droonga/droonga-client-ruby at 7a2440f [master] Delete "--receiver-port" option of droonga-request.
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]