[Groonga-commit] groonga/groonga at 24ae208 [master] doc: follow new markup guideline about clearlock command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:24:34 JST 2014


naoa	2014-08-12 08:24:34 +0900 (Tue, 12 Aug 2014)

  New Revision: 24ae20867e13c03109ea3e895a4c76896fa63f6e
  https://github.com/groonga/groonga/commit/24ae20867e13c03109ea3e895a4c76896fa63f6e

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

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

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

  Modified: doc/source/reference/commands/clearlock.rst (+25 -31)
===================================================================
--- doc/source/reference/commands/clearlock.rst    2014-08-12 08:24:09 +0900 (15a675d)
+++ doc/source/reference/commands/clearlock.rst    2014-08-12 08:24:34 +0900 (5c6f292)
@@ -2,39 +2,46 @@
 
 .. highlightlang:: none
 
-clearlock
-=========
+``clearlock``
+=============
 
-名前
-----
+Summary
+-------
 
 clearlock - オブジェクトにセットされたロックを解除する
 
-書式
-----
+Groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準>入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられた>ロックを再帰的に解除します。
+
+Syntax
+------
 ::
 
  clearlock objname
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるclearlockについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+開いているデータベースのロックをすべて解除する::
 
-clearlockは、対象となるオブジェクト(データベース,テーブル,インデックス等)を指定し、オブジェクトにかけられたロックを再帰的に解除します。
+ clearlock
+ [true]
 
-引数
-----
+テーブル名 Entry のカラム body のロックを解除する::
+
+ clearlock Entry.body
+ [true]
+
+Parameters
+----------
 
 ``objname``
 
   対象となるオブジェクト名を指定します。空の場合、開いているdbオブジェクトが対象となります。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -44,20 +51,7 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-
-開いているデータベースのロックをすべて解除する::
-
- clearlock
- [true]
-
-テーブル名 Entry のカラム body のロックを解除する::
-
- clearlock Entry.body
- [true]
-
-関連項目
+See also
 --------
 
 :doc:`load`
-------------- next part --------------
HTML����������������������������...
Télécharger 



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