Kouhei Sutou
null+****@clear*****
Mon Nov 25 17:27:50 JST 2013
Kouhei Sutou 2013-11-25 17:27:50 +0900 (Mon, 25 Nov 2013) New Revision: 08735991ee5058579c364445f6ae2b83465676a6 https://github.com/groonga/groonga/commit/08735991ee5058579c364445f6ae2b83465676a6 Message: Follow file name change of groonga-benchmark Modified files: doc/files.am Renamed files: doc/source/reference/executables/groonga-benchmark.txt (from doc/source/reference/executables/grntest.txt) Modified: doc/files.am (+4 -4) =================================================================== --- doc/files.am 2013-11-25 16:33:07 +0900 (80dbe37) +++ doc/files.am 2013-11-25 17:27:50 +0900 (2935e4c) @@ -415,7 +415,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/commands/truncate.txt \ $(top_srcdir)/doc/source/reference/command.txt \ $(top_srcdir)/doc/source/reference/executables/grnslap.txt \ - $(top_srcdir)/doc/source/reference/executables/grntest.txt \ + $(top_srcdir)/doc/source/reference/executables/groonga-benchmark.txt \ $(top_srcdir)/doc/source/reference/executables/groonga-httpd.txt \ $(top_srcdir)/doc/source/reference/executables/groonga-server-http.txt \ $(top_srcdir)/doc/source/reference/executables/groonga-suggest-create-dataset.txt \ @@ -912,7 +912,7 @@ source_files_relative_from_doc_dir = \ source/reference/commands/truncate.txt \ source/reference/command.txt \ source/reference/executables/grnslap.txt \ - source/reference/executables/grntest.txt \ + source/reference/executables/groonga-benchmark.txt \ source/reference/executables/groonga-httpd.txt \ source/reference/executables/groonga-server-http.txt \ source/reference/executables/groonga-suggest-create-dataset.txt \ @@ -1167,7 +1167,7 @@ html_files_relative_from_locale_dir = \ html/reference/commands/tokenize.html \ html/reference/commands/truncate.html \ html/reference/executables/grnslap.html \ - html/reference/executables/grntest.html \ + html/reference/executables/groonga-benchmark.html \ html/reference/executables/groonga.html \ html/reference/executables/groonga-httpd.html \ html/reference/executables/groonga-server-http.html \ @@ -1304,7 +1304,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/truncate.txt \ html/_sources/reference/command.txt \ html/_sources/reference/executables/grnslap.txt \ - html/_sources/reference/executables/grntest.txt \ + html/_sources/reference/executables/groonga-benchmark.txt \ html/_sources/reference/executables/groonga-httpd.txt \ html/_sources/reference/executables/groonga-server-http.txt \ html/_sources/reference/executables/groonga-suggest-create-dataset.txt \ Renamed: doc/source/reference/executables/groonga-benchmark.txt (+31 -31) 61% =================================================================== --- doc/source/reference/executables/grntest.txt 2013-11-25 16:33:07 +0900 (59efc61) +++ doc/source/reference/executables/groonga-benchmark.txt 2013-11-25 17:27:50 +0900 (bf24113) @@ -2,29 +2,29 @@ .. highlightlang:: none -grntest -======= +groonga-benchmark +================= 名前 ---- -grntest - groongaテストプログラム +groonga-benchmark - groongaテストプログラム 書式 ---- :: - grntest [options...] [script] [db] + groonga-benchmark [options...] [script] [db] 説明 ---- -grntestは、groonga汎用テストツールです。 +groonga-benchmarkは、groonga汎用ベンチマークツールです。 groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。 -grntest用のデータファイルは自分で作成することも既存のものを利用することもできます。既存のデータファイルは、ftp.groonga.orgから必要に応じダウンロードします。そのため、groonga及びgrntestが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。 +groonga-benchmark用のデータファイルは自分で作成することも既存のものを利用することもできます。既存のデータファイルは、ftp.groonga.orgから必要に応じダウンロードします。そのため、groonga及びgroonga-benchmarkが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。 現在は、Linux 及びWindows上で動作します。make installしてもインストールは行われません。 @@ -32,7 +32,7 @@ grntest用のデータファイルは自分で作成することも既存のも ---------- .. cmdoption:: -i, --host <ip/hostname> - 接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、grntestは自動的にlocalhostのgroongaサーバを起動して接続します。 + 接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、groonga-benchmarkは自動的にlocalhostのgroongaサーバを起動して接続します。 .. cmdoption:: -p, --port <port number> @@ -50,7 +50,7 @@ grntest用のデータファイルは自分で作成することも既存のも .. cmdoption:: --log-output-dir - デフォルトでは、grntest終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。 + デフォルトでは、groonga-benchmark終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。 .. cmdoption:: --groonga <groonga_path> @@ -65,20 +65,20 @@ grntest用のデータファイルは自分で作成することも既存のも .. cmdoption:: script - grntestの動作方法(以下、grntest命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。 + groonga-benchmarkの動作方法(以下、groonga-benchmark命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。 .. cmdoption:: db - grntestが利用するgroonga データベースです。指定されたデータベースが存在しない場合、grntestが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。 + groonga-benchmarkが利用するgroonga データベースです。指定されたデータベースが存在しない場合、groonga-benchmarkが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。 使い方 ------ まず、シェル上(Windowsならコマンドプロンプト上)で:: - grntest test.scr 任意のDB名 + groonga-benchmark test.scr 任意のDB名 -とタイプしてください。もしgrntestが正常に動作すれば、:: +とタイプしてください。もしgroonga-benchmarkが正常に動作すれば、:: test-ユーザ名-数字.log @@ -88,20 +88,20 @@ grntest用のデータファイルは自分で作成することも既存のも スクリプトファイル ------------------ -スクリプトファイルは、grntest命令を記述したテキストファイルです。 -";"セミコロンを利用して、一行に複数のgrntest命令を記述することができます。一行に複数のgrntest命令がある場合、各命令は並列に実行されます。 +スクリプトファイルは、groonga-benchmark命令を記述したテキストファイルです。 +";"セミコロンを利用して、一行に複数のgroonga-benchmark命令を記述することができます。一行に複数のgroonga-benchmark命令がある場合、各命令は並列に実行されます。 "#"で始まる行はコメントとして扱われます。 -grntest命令 -^^^^^^^^^^^ +groonga-benchmark命令 +^^^^^^^^^^^^^^^^^^^^^ -現在サポートされているgrntest命令は以下の8つです。 +現在サポートされているgroonga-benchmark命令は以下の8つです。 do_local コマンドファイル [スレッド数] [繰り返し数] - コマンドファイルをgrntest単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。 + コマンドファイルをgroonga-benchmark単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。 do_gqpt コマンドファイル [スレッド数] [繰り返し数] @@ -109,7 +109,7 @@ grntest命令 rep_local コマンドファイル [スレッド数] [繰り返し数] - コマンドファイルをgrntest単体で実行し、より詳細な報告を行います。 + コマンドファイルをgroonga-benchmark単体で実行し、より詳細な報告を行います。 rep_gqpt コマンドファイル [スレッド数] [繰り返し数] @@ -117,7 +117,7 @@ grntest命令 out_local コマンドファイル 入力ファイル名 - コマンドファイルをgrntest単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local, test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、grntest実行時に自動的に作成されるログとは別のものです。grntestではコメントが利用できる以外、:: + コマンドファイルをgroonga-benchmark単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local, test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、groonga-benchmark実行時に自動的に作成されるログとは別のものです。groonga-benchmarkではコメントが利用できる以外、:: groonga < コマンドファイル > 出力ファイル @@ -128,7 +128,7 @@ grntest命令 コマンドファイルをgroongaサーバで実行します。その他はout_local命令と同等です。 test_local コマンドファイル 入力ファイル名 - コマンドファイルをgrntest単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。 + コマンドファイルをgroonga-benchmark単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。 コマンドファイル @@ -154,7 +154,7 @@ grntest命令 2行目 test.dll というコマンドファイルをgroonga単体で実行し、詳細に報告する。 3行目 - test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgrntest命令を記述する場合に必要ですが、この例のように1つのgrntest命令を実行する場合に付与しても問題ありません。) + test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgroonga-benchmark命令を記述する場合に必要ですが、この例のように1つのgroonga-benchmark命令を実行する場合に付与しても問題ありません。) 4行目 test.select というコマンドファイルをgroongaサーバで10個のスレッドで同時に実行する。各スレッドはtest.selectの中身を10回繰り返す。また同時に、groonga単体でtest.statusというコマンドファイルを10個のスレッドで実行する。 @@ -176,7 +176,7 @@ grntest命令 :: - $ ./grntest --port 20010 test.scr testdb + $ ./groonga-benchmark --port 20010 test.scr testdb とコマンド上でポートを指定した場合でも、もしtest.scrの中身が @@ -191,10 +191,10 @@ grntest命令 であれば、自動的に起動されるgroongaサーバはポート番号10400を利用します。 -grntest実行結果 +groonga-benchmark実行結果 --------------- -grntestが正常に終了すると、(拡張子を除いた)スクリプト名-ユーザ名-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org +groonga-benchmarkが正常に終了すると、(拡張子を除いた)スクリプト名-ユーザ名-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org に送信されます。ログファイルは以下のようなjson形式のテキストです。 :: @@ -254,7 +254,7 @@ grntestが正常に終了すると、(拡張子を除いた)スクリプト名- 制限事項 -------- -* スクリプトファイルの一行には複数のgrntest命令を記述できますが、すべてのスレッド数の合計は最大64までに制限されます。 +* スクリプトファイルの一行には複数のgroonga-benchmark命令を記述できますが、すべてのスレッド数の合計は最大64までに制限されます。 * コマンドファイル中のgroongaコマンドの長さは最長5000000byteです。 @@ -262,12 +262,12 @@ grntestが正常に終了すると、(拡張子を除いた)スクリプト名- トラブルシューティング ---------------------- -もし、grntestが正常に動作しない場合、まず以下を確認してください。 +もし、groonga-benchmarkが正常に動作しない場合、まず以下を確認してください。 -* インターネットに接続しているか？ `--ftp` オプションを指定すると、grntestは動作のたびにftp.groonga.orgと通信します。ftp.groonga.orgと通信可能でない場合、grntestは正常に動作しません。 +* インターネットに接続しているか？ `--ftp` オプションを指定すると、groonga-benchmarkは動作のたびにftp.groonga.orgと通信します。ftp.groonga.orgと通信可能でない場合、groonga-benchmarkは正常に動作しません。 -* groonga サーバが動作していないか？ grntestは、-i, --host オプションで明示的にサーバを指定しないかぎり、自動的にlocalhostのgroongaサーバを立ち上げます。すでにgroongaサーバが動作している場合、grntestは正常に動作しない可能性があります。 +* groonga サーバが動作していないか？ groonga-benchmarkは、-i, --host オプションで明示的にサーバを指定しないかぎり、自動的にlocalhostのgroongaサーバを立ち上げます。すでにgroongaサーバが動作している場合、groonga-benchmarkは正常に動作しない可能性があります。 -* 指定したDBが適切か？ grntestは、引数で指定したDBの中身はチェックしません。もし指定されたDBが存在しなければ自動的にDBを作成しますが、もしファイルとして存在する場合は中身に関わらず動作を続けてしまい、結果が異常になる可能性があります。 +* 指定したDBが適切か？ groonga-benchmarkは、引数で指定したDBの中身はチェックしません。もし指定されたDBが存在しなければ自動的にDBを作成しますが、もしファイルとして存在する場合は中身に関わらず動作を続けてしまい、結果が異常になる可能性があります。 -以上の原因でなければ、問題はgrntestかgroongaにあります。ご報告をお願いします。 +以上の原因でなければ、問題はgroonga-benchmarkかgroongaにあります。ご報告をお願いします。 -------------- next part -------------- HTML����������������������������...Download