[Groonga-commit] groonga/groonga at 802ec10 [master] doc: follow new markup guideline about log_reopen command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:26:17 JST 2014


naoa	2014-08-12 08:26:17 +0900 (Tue, 12 Aug 2014)

  New Revision: 802ec10fbe933c0d3fe1b825167156d6c7a93eb9
  https://github.com/groonga/groonga/commit/802ec10fbe933c0d3fe1b825167156d6c7a93eb9

  Merged 13a8eb1: Merge pull request #189 from naoa/reformat-command-reference

  Message:
    doc: follow new markup guideline about log_reopen command documentation

  Modified files:
    doc/source/reference/commands/log_reopen.rst

  Modified: doc/source/reference/commands/log_reopen.rst (+29 -34)
===================================================================
--- doc/source/reference/commands/log_reopen.rst    2014-08-12 08:26:06 +0900 (3e2ee37)
+++ doc/source/reference/commands/log_reopen.rst    2014-08-12 08:26:17 +0900 (1b3ae93)
@@ -2,50 +2,29 @@
 
 .. highlightlang:: none
 
-log_reopen
-==========
+``log_reopen``
+==============
 
-名前
-----
+Summary
+-------
 
 log_reopen - ログファイルの再読み込み
 
-書式
-----
-::
-
- log_reopen
-
-説明
-----
-
-Groonga組込コマンドの一つであるlog_reopenについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Groonga組込コマンドの一つであるlog_reopenについて説明します。組込コマンドは、groonga実行ファイルの引数、標準
+入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
 
 log_reopenは、ログファイルを再読み込みします。
 
 現在、デフォルトのログ関数を用いている場合のみに対応しています。
 
-引数
-----
-
-ありません。
-
-返値
-----
-
-json形式
-^^^^^^^^
-
+Syntax
+------
 ::
 
- [成功かどうかのフラグ]
-
-``成功かどうかのフラグ``
-
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+ log_reopen
 
-例
---
+Usage
+-----
 ::
 
  log_reopen
@@ -53,7 +32,7 @@ json形式
  [true]
 
 log_reopenを用いたログのローテーション
---------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 1. ログファイルをmvなどで移動する。
    ログはmvで移動された先のファイルに書き込まれる。
@@ -61,7 +40,23 @@ log_reopenを用いたログのローテーション
 3. 既存のログファイル名と同じファイル名で、新たなログファイルが作成される。
    今後のログは新たなログファイルに書き込まれる。
 
-関連項目
+Parameters
+----------
+
+ありません。
+
+Return value
+------------
+
+::
+
+ [成功かどうかのフラグ]
+
+``成功かどうかのフラグ``
+
+  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+
+See also
 --------
 
 :doc:`log_level`
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index