changeset 2542:bde7cd9a1173

Added examples of state path to keyval.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 19 May 2020 12:54:47 +0100
parents 0e6bbd8138c4
children f39c4724c0f8
files xml/en/docs/http/ngx_http_keyval_module.xml xml/en/docs/stream/ngx_stream_keyval_module.xml
diffstat 2 files changed, 20 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_keyval_module.xml
+++ b/xml/en/docs/http/ngx_http_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_keyval_module"
         link="/en/docs/http/ngx_http_keyval_module.html"
         lang="en"
-        rev="9">
+        rev="10">
 
 <section id="summary">
 
@@ -37,7 +37,7 @@ This module is available as part of our
 <example>
 http {
 
-    keyval_zone zone=one:32k state=one.keyval;
+    keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
     keyval $arg_text $text zone=one;
     ...
     server {
@@ -103,6 +103,14 @@ that keeps the current state of the key-
 and makes it persistent across nginx restarts.
 </para>
 
+<para>
+Examples:
+<example>
+keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval; # path for Linux
+keyval_zone zone=one:32k state=/var/db/nginx/state/one.keyval;  # path for FreeBSD
+</example>
+</para>
+
 <para id="keyval_timeout">
 The optional <literal>timeout</literal> parameter (1.15.0) sets
 the time after which key-value pairs are removed from the zone.
--- a/xml/en/docs/stream/ngx_stream_keyval_module.xml
+++ b/xml/en/docs/stream/ngx_stream_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_keyval_module"
         link="/en/docs/stream/ngx_stream_keyval_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -45,7 +45,7 @@ http {
 
 stream {
 
-    keyval_zone zone=one:32k state=one.keyval;
+    keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
     keyval      $ssl_server_name $name zone=one;
 
     server {
@@ -107,6 +107,14 @@ that keeps the current state of the key-
 and makes it persistent across nginx restarts.
 </para>
 
+<para>
+Examples:
+<example>
+keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval; # path for Linux
+keyval_zone zone=one:32k state=/var/db/nginx/state/one.keyval;  # path for FreeBSD
+</example>
+</para>
+
 <para id="keyval_timeout">
 The optional <literal>timeout</literal> parameter (1.15.0) sets
 the time after which key-value pairs are removed from the zone.