YUKI Hiroshi
null+****@clear*****
Fri May 8 12:21:12 JST 2015
YUKI Hiroshi 2015-05-08 12:21:12 +0900 (Fri, 08 May 2015) New Revision: 8508f39bbf63d8e1cf18ab65aabc5f6273d79996 https://github.com/droonga/droonga-engine/commit/8508f39bbf63d8e1cf18ab65aabc5f6273d79996 Message: Brush up descriptions of command line options Modified files: bin/droonga-engine-catalog-generate Modified: bin/droonga-engine-catalog-generate (+23 -12) =================================================================== --- bin/droonga-engine-catalog-generate 2015-05-08 11:30:29 +0900 (9e299f3) +++ bin/droonga-engine-catalog-generate 2015-05-08 12:21:12 +0900 (1a8d7a9) @@ -43,59 +43,70 @@ end parser = OptionParser.new parser.version = Droonga::Engine::VERSION parser.on("--output=PATH", - "Output catalog.json to PATH.", + "The output path of generated catalog.json to be saved as.", "\"-\" means the standard output.", "(#{options.output_path})") do |path| options.output_path = path end parser.on("--dataset=NAME", - "Add a dataset its name is NAME.", - "And set the NAME to the current dataset.", + "The name of a new dataset.", + "This can be specified multiple times to define multiple datasets.", "(#{Droonga::Catalog::Generator::DEFAULT_DATASET})") do |name| current_dataset = datasets[name] = {} end parser.on("--n-workers=N", Integer, - "Use N workers for the current dataset.", + "Number of workers for each volume in the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_N_WORKERS})") do |n| current_dataset[:n_workers] = n end parser.on("--hosts=NAME1,NAME2,...", Array, - "Use given hosts for replicas of the current dataset.", + "Host names of engine nodes to be used as replicas in the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_HOSTS.join(",")})") do |hosts| current_dataset[:hosts] = hosts end parser.on("--port=PORT", Integer, - "Use the PORT as the port for the current dataset.", + "Port number to communicate with engine nodes in the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_PORT})") do |port| current_dataset[:port] = port end parser.on("--tag=TAG", - "Use the TAG as the tag for the current dataset.", + "Tag name to communicate with engine nodes in the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_TAG})") do |tag| current_dataset[:tag] = tag end parser.on("--n-slices=N", Integer, - "Use N slices for each replica.", + "Number of slices for each replica in the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_N_SLICES})") do |n| current_dataset[:n_slices] = n end parser.on("--plugins=PLUGIN1,PLUGIN2,...", Array, - "Use PLUGINS for the current dataset.", + "Plugin names activated for the dataset ", + "specified by the preceding --dataset option.", "(#{Droonga::Catalog::Generator::DEFAULT_PLUGINS.join(",")})") do |plugins| current_dataset[:plugins] = plugins end parser.on("--schema=PATH", - "Use schema in JSON at PATH for the current dataset.") do |path| + "The path to a JSON file including schema definition for the dataset ", + "specified by the preceding --dataset option.") do |path| File.open(path) do |input| current_dataset[:schema] = JSON.parse(input.read) end end parser.on("--fact=TABLE", - "Use TABLE as the fact table for the current dataset.") do |table| + "Name of the fact table in the dataset ", + "specified by the preceding --dataset option.") do |table| current_dataset[:fact] = table end parser.on("--replicas=PATH", - "Use replicas in JSON at PATH for the current dataset.") do |path| + "The path to a JSON file including replicas definition for the dataset ", + "specified by the preceding --dataset option.", + "If this option is used, other options to define replicas in the dataset ", + "(--hosts, --port, --tag and --n-slices) are ignored.") do |path| File.open(path) do |input| current_dataset[:replicas] = JSON.parse(input.read) end -------------- next part -------------- HTML����������������������������...下载
