summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorFrankie Robertson <frankie@robertson.name>2014-12-23 15:38:34 +0200
committerTim Graham <timograham@gmail.com>2014-12-23 14:40:40 -0500
commit70c965ad4ff06337229c4095a2b2221467781b92 (patch)
treec36b3c979b803cc45bbdffca4297ec0211800e22 /docs/ref
parentd237aaa9293e61d0cd854450da41ab80df4d4957 (diff)
[1.6.x] Fixed #24035 -- Clarified docs on CACHE_MIDDLEWARE_KEY_PREFIX vs KEY_PREFIX
Backport of 446b50b90e9e60760618b236d8b0ea75a3b19d5a from master
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/settings.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 87e0c205fe..c645c9a1f1 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -272,7 +272,8 @@ CACHE_MIDDLEWARE_ALIAS
Default: ``default``
-The cache connection to use for the cache middleware.
+The cache connection to use for the :ref:`cache middleware
+<the-per-site-cache>`.
.. setting:: CACHE_MIDDLEWARE_ANONYMOUS_ONLY
@@ -301,7 +302,9 @@ CACHE_MIDDLEWARE_KEY_PREFIX
Default: ``''`` (Empty string)
-The cache key prefix that the cache middleware should use.
+A string which will be prefixed to the cache keys generated by the :ref:`cache
+middleware <the-per-site-cache>`. This prefix is combined with the
+:setting:`KEY_PREFIX <CACHES-KEY_PREFIX>` setting; it does not replace it.
See :doc:`/topics/cache`.
@@ -312,8 +315,8 @@ CACHE_MIDDLEWARE_SECONDS
Default: ``600``
-The default number of seconds to cache a page when the caching middleware or
-``cache_page()`` decorator is used.
+The default number of seconds to cache a page for the :ref:`cache middleware
+<the-per-site-cache>`.
See :doc:`/topics/cache`.