[Groonga-commit] groonga/groonga at f8af97a [master] doc: add io_flush document

Back to archive index

Masafumi Yokoyama null+****@clear*****
Thu Jun 25 15:18:52 JST 2015


Masafumi Yokoyama	2015-06-25 15:18:52 +0900 (Thu, 25 Jun 2015)

  New Revision: f8af97afc7cb803139cf055136788917d917f041
  https://github.com/groonga/groonga/commit/f8af97afc7cb803139cf055136788917d917f041

  Message:
    doc: add io_flush document
    
    TODO: add description about summary, usage and parameters.

  Added files:
    doc/source/reference/commands/io_flush.rst

  Added: doc/source/reference/commands/io_flush.rst (+60 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/commands/io_flush.rst    2015-06-25 15:18:52 +0900 (f0ffe8d)
@@ -0,0 +1,60 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: io_flush
+
+``io_flush``
+============
+
+Summary
+-------
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.5
+
+TODO
+
+Syntax
+------
+
+``io_flush`` command has two parameters. ::
+
+  io_flush [target_name]
+           [recursive=yes]
+
+Usage
+-----
+
+TODO
+
+Parameters
+----------
+
+This section describes parameters of ``io_flush``.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``target_name``
+"""""""""""""""
+
+TODO
+
+``recursive``
+"""""""""""""
+
+TODO
+
+Return value
+------------
+
+::
+
+  [HEADER, true]
-------------- next part --------------
HTML����������������������������...
Download 



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