[Groonga-commit] groonga/groonga at 67310e0 [master] doc: follow new markup guideline about defrag command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:25:29 JST 2014


naoa	2014-08-12 08:25:29 +0900 (Tue, 12 Aug 2014)

  New Revision: 67310e017d7c97b067ab9468dc2a63e18e244d3e
  https://github.com/groonga/groonga/commit/67310e017d7c97b067ab9468dc2a63e18e244d3e

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

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

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

  Modified: doc/source/reference/commands/defrag.rst (+26 -29)
===================================================================
--- doc/source/reference/commands/defrag.rst    2014-08-12 08:25:12 +0900 (46e9f2b)
+++ doc/source/reference/commands/defrag.rst    2014-08-12 08:25:29 +0900 (685ec5e)
@@ -2,39 +2,48 @@
 
 .. highlightlang:: none
 
-defrag
-======
+``defrag``
+==========
 
-名前
-----
+Summary
+-------
 
 ``defrag`` command resolves fragmentation of specified objects.
 
-書式
-----
+Groonga組込コマンドの一つであるdefragについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力
+、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+defragは、対象となるオブジェクト(データベースか可変長サイズカラム)を指定し、オブジェクトのフラグメンテーショ
+ンを解消します。
+
+Syntax
+------
 ::
 
  defrag objname threshold
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるdefragについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+開いているデータベースのフラグメンテーションを解消する::
 
-defragは、対象となるオブジェクト(データベースか可変長サイズカラム)を指定し、オブジェクトのフラグメンテーションを解消します。
+ defrag
+ [300]
 
-引数
-----
+テーブル名 Entry のカラム body のフラグメンテーションを解消する::
+
+ defrag Entry.body
+ [30]
+
+Parameters
+----------
 
 ``objname``
 
   対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -44,15 +53,3 @@ json形式
 
   フラグメンテーション解消を実行したセグメントの数を返す。
 
-例
---
-
-開いているデータベースのフラグメンテーションを解消する::
-
- defrag
- [300]
-
-テーブル名 Entry のカラム body のフラグメンテーションを解消する::
-
- defrag Entry.body
- [30]
-------------- next part --------------
HTML����������������������������...
Download 



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