From: Jorge Pereira <jpereiran@gmail.com>
Date: Tue, 29 Jan 2019 20:27:47 +0000 (-0200)
Subject: Enable table section for raddb/mods-available/cache
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=be67d173030a3ca2796b32afbf9332e4a2d19bdf;p=thirdparty%2Ffreeradius-server.git

Enable table section for raddb/mods-available/cache
---

diff --git a/raddb/mods-available/cache b/raddb/mods-available/cache
index 5e06d286044..21bad841fea 100644
--- a/raddb/mods-available/cache
+++ b/raddb/mods-available/cache
@@ -19,10 +19,14 @@
 #  sections, you will need to define multiple instances of the module,
 #  via `cache <nameN> { ... }`.
 #
-#  * The module returns `ok` if it found or created a cache entry.
-#  * The module returns `updated` if it merged a cached entry.
-#  * The module returns `noop` if it did nothing.
-#  * The module returns `fail` on error.
+#  [options="header,autowidth"]
+#  |===
+#  | Option    | Description
+#  | `ok`      | if it found or created a cache entry.
+#  | `updated` | if it merged a cached entry.
+#  | `noop`    | if it did nothing.
+#  | `fail`    | on error.
+#  |===
 #
 
 #
@@ -33,20 +37,27 @@ cache {
 	# driver::
 	#
 	#  The current backend datastore used to store the cache entries are:
-	#  * `rlm_cache_rbtree`    - An in memory, non persistent rbtree based datastore.
+	#
+	#  [options="header,autowidth"]
+	#  |===
+	#  | Driver                | Description
+	#  | `rlm_cache_rbtree`    | An in memory, non persistent rbtree based datastore.
 	#                            Useful for caching data locally.
-	#  * `rlm_cache_memcached` - A non persistent "webscale" distributed datastore.
+	#  | `rlm_cache_memcached` | A non persistent "webscale" distributed datastore.
 	#                            Useful if the cached data need to be shared between
 	#                            a cluster of RADIUS servers.
-	#  * `rlm_cache_redis`     - A persistent "webscale" clustered, sharded, data store.
+	#  | `rlm_cache_redis`     | A persistent "webscale" clustered, sharded, data store.
 	#                            Extremely fast, and a good candidate for sharing
 	#                            data such as EAP session blobs, between a cluster of
 	#                            servers.
+	#  |===
+	#
 #	driver = "rlm_cache_rbtree"
 
 	#
 	#  NOTE: Some drivers accept specific options, to set them a config section with the
 	#  the name as the driver should be added to the cache instance.
+	#
 	#  Driver specific options are:
 	#
 
@@ -84,7 +95,9 @@ cache {
 		#  If using Redis cluster, multiple 'bootstrap' servers may be
 		#  listed here (as separate config items). These will be contacted
 		#  in turn until one provides us with a valid map for the cluster.
-		#  Server strings may contain unique ports e.g.:
+		#  Server strings may contain unique ports.
+		#
+		#  e.g.:
 		#
 		#    server = '127.0.0.1:30001'
 		#    server = '[::1]:30002'
@@ -128,9 +141,8 @@ cache {
 #	}
 
 	#
-	# key::
+	# key:: The `key` used to index the cache. It is dynamically expanded at run time.
 	#
-	#  The key used to index the cache. It is dynamically expanded at run time.
 	key = &User-Name
 
 	#
@@ -212,7 +224,7 @@ cache {
 	#   * The module will return `ok` if a cache entry was found.
 	#   * The module will return `notfound` if no cache entry was found.
 	#
-	#  NOTE:: If this is set to `yes`, no other cache control attributes will
+	#  NOTE: If this is set to `yes`, no other cache control attributes will
 	#  be honoured, but they will still be cleared.
 	#
 	#  `&control:Cache-Allow-Insert`:: If present and set to `no` will
@@ -234,4 +246,5 @@ cache {
 	#
 	#  NOTE: All runtime configuration attributes will be removed from the
 	#  `&control:` list after the cache module is called.
+	#
 }