doc: document --cache-base-path

groonga · Apr 28, 2017 · 00258df · 00258df
1 parent e736b5c
commit 00258df
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/doc/source/news.rst b/doc/source/news.rst
@@ -33,8 +33,8 @@ Improvements
   * ``grn_persistent_cache_open()``
   * ``grn_cache_default_open()``
 
-* [:doc:`/reference/executables/groonga`] Supported
-  ``--cache-base-path`` option to use persistent cache.
+* [:doc:`/reference/executables/groonga`][:option:`--cache-base-path
+  <path>`] Added a new option to use persistent cache.
 
 * [:doc:`/reference/executables/groonga-httpd`] Supported
   ``groonga_cache_base_path`` option to use persistent cache.

diff --git a/doc/source/reference/executables/groonga.rst b/doc/source/reference/executables/groonga.rst
@@ -327,6 +327,28 @@ Options
 
    .. seealso:: :doc:`/reference/command/request_timeout`
 
+.. cmdoption:: --cache-base-path <path>
+
+   .. versionadded:: 7.0.2
+
+   Specifies the base path for cache. It enables persistent cache
+   feature.
+
+   You can get the following merits by persistent cache feature:
+
+     * You can reuse cache after ``groonga`` process is restarted. You
+       don't need to warm up your cache each restart.
+
+     * You can share cache with multiple ``groonga`` processes.
+
+   You must specify the base path on memory file system. If you
+   specify the base path on disk, your cache will be slow. It's not
+   make sense.
+
+   The default is nothing. It means that persistent cache is
+   disabled. On memory cache is used.
+
+
 Command line parameters
 -----------------------