[Groonga-commit] groonga/groonga at 00258df [master] doc: document --cache-base-path

Back to archive index

Kouhei Sutou null+****@clear*****
Fri Apr 28 12:02:11 JST 2017


Kouhei Sutou	2017-04-28 12:02:11 +0900 (Fri, 28 Apr 2017)

  New Revision: 00258df5028b50d9d1e5a5f77c6e7a24564652a9
  https://github.com/groonga/groonga/commit/00258df5028b50d9d1e5a5f77c6e7a24564652a9

  Message:
    doc: document --cache-base-path

  Modified files:
    doc/source/news.rst
    doc/source/reference/executables/groonga.rst

  Modified: doc/source/news.rst (+2 -2)
===================================================================
--- doc/source/news.rst    2017-04-28 11:39:39 +0900 (9e7ed13)
+++ doc/source/news.rst    2017-04-28 12:02:11 +0900 (4193126)
@@ -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.

  Modified: doc/source/reference/executables/groonga.rst (+22 -0)
===================================================================
--- doc/source/reference/executables/groonga.rst    2017-04-28 11:39:39 +0900 (af55574)
+++ doc/source/reference/executables/groonga.rst    2017-04-28 12:02:11 +0900 (3ba3e3a)
@@ -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
 -----------------------
 
-------------- next part --------------
HTML����������������������������...
Download 



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