[Groonga-commit] groonga/groonga at 400f708 [master] doc config_get: add missing parameters section

Back to archive index

Kouhei Sutou null+****@clear*****
Tue Jan 26 15:26:49 JST 2016


Kouhei Sutou	2016-01-26 15:26:49 +0900 (Tue, 26 Jan 2016)

  New Revision: 400f7085dead968e48aafbcb84c8302c63f4cc04
  https://github.com/groonga/groonga/commit/400f7085dead968e48aafbcb84c8302c63f4cc04

  Message:
    doc config_get: add missing parameters section

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

  Modified: doc/source/reference/commands/config_get.rst (+26 -0)
===================================================================
--- doc/source/reference/commands/config_get.rst    2016-01-26 15:26:37 +0900 (b1f293c)
+++ doc/source/reference/commands/config_get.rst    2016-01-26 15:26:49 +0900 (d8f369a)
@@ -43,6 +43,32 @@ Here is an example to get nonexistent configuration item value:
 ``config_get`` returns an empty string for nonexistent configuration
 item key.
 
+Parameters
+----------
+
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is one required parameter.
+
+.. _config-get-key:
+
+``key``
+"""""""
+
+Specifies the key of target configuration item.
+
+The max key size is 4KiB.
+
+You can't use an empty string as key.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no optional parameters.
+
 Return value
 ------------
 
-------------- next part --------------
HTML����������������������������...
Download 



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