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:35 -0500
commit126eb58abef119b799f81bd3626cb777910847cf (patch)
treea7382bbd76f88c4aae4c1241a1f426a528f0ea12 /docs/ref
parent51ea30a43bafad40b4a24ad0be346796a9c7ab6a (diff)
[1.7.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 0f39d23c6d..87760b86e2 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -283,7 +283,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
@@ -312,7 +313,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`.
@@ -323,8 +326,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`.