Kouhei Sutou
null+****@clear*****
Sun Mar 13 12:57:17 JST 2016
Kouhei Sutou 2016-03-13 12:57:17 +0900 (Sun, 13 Mar 2016) New Revision: 0aea0659412bf6f2f8d47c05f5bcfee27f6397b9 https://github.com/groonga/groonga/commit/0aea0659412bf6f2f8d47c05f5bcfee27f6397b9 Message: doc: document about immediate shutdown Added files: doc/source/example/reference/commands/shutdown/default.log doc/source/example/reference/commands/shutdown/graceful.log doc/source/example/reference/commands/shutdown/immediate.log Modified files: doc/locale/ja/LC_MESSAGES/reference.po doc/source/reference/commands/shutdown.rst Modified: doc/locale/ja/LC_MESSAGES/reference.po (+76 -9) =================================================================== --- doc/locale/ja/LC_MESSAGES/reference.po 2016-03-13 12:22:45 +0900 (ef38ac5) +++ doc/locale/ja/LC_MESSAGES/reference.po 2016-03-13 12:57:17 +0900 (449dfd1) @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: 1.2.1\n" "Report-Msgid-Bugs-To: \n" -"PO-Revision-Date: 2016-03-11 17:55+0900\n" +"PO-Revision-Date: 2016-03-13 12:55+0900\n" "Last-Translator: Masafumi Yokoyama <yokoyama �� clear-code.com>\n" "Language-Team: Japanese\n" "Language: ja\n" @@ -11184,17 +11184,87 @@ msgstr "" msgid "``shutdown``" msgstr "" -msgid "shutdown - サーバプロセスの停止" +msgid "``shutdown`` stops the Groonga server process." +msgstr "``shutdown`` はGroongaサーバープロセスを終了します。" + +msgid "" +"``shutdown`` uses graceful shutdown by default. If there are some running " +"commands, the Groonga server process stops after these running commands are " +"finished. New command requests aren't processed after ``shutdown`` command " +"is executed." msgstr "" +"``shutdown`` はデフォルトではgraceful shutdownを使います。もし、実行中のコマ" +"ンドがあるならそれらのコマンドが終了してからGroongaサーバープロセスを終了しま" +"す。 ``shutdown`` コマンドを実行した後は新しいコマンドを実行されません。" msgid "" -"Groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、" -"groonga実行ファイルの引数、標準入 力、またはソケット経由でgroongaサーバにリク" -"エストを送信することによって実行します。" +"``shutdown`` uses immediate shutdown by specifying ``immediate`` to ``mode`` " +"parameter. The Groonga server process stops immediately even when there are " +"some running commands." +msgstr "" +"``shutdown`` は ``mode`` パラメーターに ``immediate`` を指定するとimmediate " +"shutdownを使います。たとえ実行中のコマンドがあってもGroongaサーバープロセスを" +"すぐに終了します。" + +msgid "``shutdown`` use graceful shutdown by default::" +msgstr "``shutdown`` はデフォルトではgraceful shutdownを使います。::" + +msgid "You can specify ``graceful`` to ``mode`` parameter explicitly::" +msgstr "" +"明示的に ``mode`` パラメーターに ``graceful`` を指定することもできます。::" + +msgid "" +"You can choose immediate shutdown by specifying ``immediate`` to ``mode`` " +"parameter::" +msgstr "" +"``mode`` パラメーターに ``immediate`` を指定することでimmediate shutdownを使" +"うことができます。::" + +msgid "" +"Immediate shutdown is useful when you don't have time for graceful shutdown. " +"For example, Windows kills service that takes long time to stop on Windows " +"shutdown." +msgstr "" +"immediate shutdownはgraceful shutdownする時間がないときに便利です。たとえば、" +"WindowsはWindowsをシャットダウンするときに時間内に終了しないサービスを強制終" +"了します。" + +msgid "This section describes parameters of this command." +msgstr "このセクションではこのコマンドのパラメーターを説明します。" + +msgid "``mode``" msgstr "" -msgid "shutdownは、接続しているgroongaサーバプロセスを停止します。" +msgid "Specifies shutdown mode. Here are available shutdown modes:" +msgstr "シャットダウンのモードを指定します。利用可能なモードは次の通りです。" + +msgid "``graceful``" +msgstr "" + +msgid "Stops after running commands are finished." +msgstr "実行中のコマンドが終了してから終了します。" + +# 41e90985794c4559baf962d155c3630d +msgid "This is the default." +msgstr "これがデフォルトです。" + +msgid "``immediate``" +msgstr "" + +msgid "Stops immediately even if there are some running commands." +msgstr "実行中のコマンドがあってもすぐに終了します。" + +# 89e4f7f7796f4f7784127f63364b6657 +msgid "``shutdown`` returns ``true`` as body when shutdown is accepted::" +msgstr "" +"``shutdown`` はシャットダウンを受け付けたときは以下のようにボディが ``true`` " +"になります。::" + +msgid "" +"If ``shutdown`` doesn't accept shutdown, error details are in ``HEADER``." msgstr "" +"``shutdown`` がシャットダウンを受け付けなかったら ``HEADER`` にエラーの詳細が" +"含まれます。" msgid "``status``" msgstr "" @@ -12480,9 +12550,6 @@ msgstr "" "詳細は、 :doc:`/reference/commands/tokenize` の :ref:`tokenize-flags` オプ" "ションを参照してください。" -msgid "``mode``" -msgstr "" - msgid "Specifies a tokenize mode." msgstr "トークナイズモードを指定します。" Added: doc/source/example/reference/commands/shutdown/default.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/shutdown/default.log 2016-03-13 12:57:17 +0900 (a7cc895) @@ -0,0 +1,4 @@ +Execution example:: + + shutdown + # [[0, 1337566253.89858, 0.000355720520019531], true] Added: doc/source/example/reference/commands/shutdown/graceful.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/shutdown/graceful.log 2016-03-13 12:57:17 +0900 (f9b3118) @@ -0,0 +1,4 @@ +Execution example:: + + shutdown --mode graceful + # [[0, 1337566253.89858, 0.000355720520019531], true] Added: doc/source/example/reference/commands/shutdown/immediate.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/shutdown/immediate.log 2016-03-13 12:57:17 +0900 (62bb5c5) @@ -0,0 +1,4 @@ +Execution example:: + + shutdown --mode immediate + # [[0, 1337566253.89858, 0.000355720520019531], true] Modified: doc/source/reference/commands/shutdown.rst (+75 -10) =================================================================== --- doc/source/reference/commands/shutdown.rst 2016-03-13 12:22:45 +0900 (3421c43) +++ doc/source/reference/commands/shutdown.rst 2016-03-13 12:57:17 +0900 (06d2e08) @@ -2,38 +2,103 @@ .. highlightlang:: none +.. groonga-command +.. database: commands_table_shutdown + ``shutdown`` ============ Summary ------- -shutdown - サーバプロセスの停止 +``shutdown`` stops the Groonga server process. + +``shutdown`` uses graceful shutdown by default. If there are some +running commands, the Groonga server process stops after these running +commands are finished. New command requests aren't processed after +``shutdown`` command is executed. -Groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入 -力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。 +``shutdown`` uses immediate shutdown by specifying ``immediate`` to +``mode`` parameter. The Groonga server process stops immediately even +when there are some running commands. -shutdownは、接続しているgroongaサーバプロセスを停止します。 Syntax ------ -:: - shutdown +This command takes only one optional parameter:: + + shutdown [mode=graceful] Usage ----- -:: - shutdown +``shutdown`` use graceful shutdown by default:: + +.. groonga-command +.. include:: ../../example/reference/commands/shutdown/default.log +.. shutdown + +You can specify ``graceful`` to ``mode`` parameter explicitly:: + +.. groonga-command +.. database: commands_table_shutdown +.. include:: ../../example/reference/commands/shutdown/graceful.log +.. shutdown --mode graceful + +You can choose immediate shutdown by specifying ``immediate`` to +``mode`` parameter:: + +.. groonga-command +.. database: commands_table_shutdown +.. include:: ../../example/reference/commands/shutdown/immediate.log +.. shutdown --mode immediate + +Immediate shutdown is useful when you don't have time for graceful +shutdown. For example, Windows kills service that takes long time to +stop on Windows shutdown. Parameters ---------- -ありません。 +This section describes parameters of this command. + +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is no required parameter. + +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +There are optional parameters. + +``mode`` +"""""""" + +Specifies shutdown mode. Here are available shutdown modes: + +.. list-table:: + :header-rows: 1 + + * - Value + - Description + * - ``graceful`` + - Stops after running commands are finished. + + This is the default. + * - ``immediate`` + - Stops immediately even if there are some running commands. Return value ------------ -ありません。 +``shutdown`` returns ``true`` as body when shutdown is +accepted:: + + [HEADER, true] + +If ``shutdown`` doesn't accept shutdown, error details are in +``HEADER``. +See :doc:`/reference/command/output_format` for ``HEADER``. -------------- next part -------------- HTML����������������������������...Télécharger
