[Groonga-commit] groonga/groonga at 9102db0 [master] doc: follow new markup guideline about status command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:27:04 JST 2014


naoa	2014-08-12 08:27:04 +0900 (Tue, 12 Aug 2014)

  New Revision: 9102db0025383fffd2017a1549e40abafd5bec0d
  https://github.com/groonga/groonga/commit/9102db0025383fffd2017a1549e40abafd5bec0d

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

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

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

  Modified: doc/source/reference/commands/status.rst (+19 -24)
===================================================================
--- doc/source/reference/commands/status.rst    2014-08-12 08:26:52 +0900 (c600f9a)
+++ doc/source/reference/commands/status.rst    2014-08-12 08:27:04 +0900 (0beb42e)
@@ -4,37 +4,38 @@
 
 .. _command-status:
 
-status
-======
+``status``
+==========
 
-名前
-----
+Summary
+-------
 
 status - groongaプロセスの状態表示
 
-書式
-----
+Groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。
+
+Syntax
+------
 ::
 
  status
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるstatusについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-statusコマンドは、groongaプロセスの状態を表示します。主にgroongaサーバプロセスに対して使用することを想定しています。
+.. groonga-command
+.. include:: ../../example/reference/commands/status.log
+.. status
 
-引数
-----
+Parameters
+----------
 
 ありません。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -52,9 +53,3 @@ json形式
 
     groongaプロセスが起動してから経過した秒数を返します。
 
-例
---
-
-.. groonga-command
-.. include:: ../../example/reference/commands/status.log
-.. status
-------------- next part --------------
HTML����������������������������...
Download 



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