From 70c965ad4ff06337229c4095a2b2221467781b92 Mon Sep 17 00:00:00 2001 From: Frankie Robertson Date: Tue, 23 Dec 2014 15:38:34 +0200 Subject: [PATCH] [1.6.x] Fixed #24035 -- Clarified docs on CACHE_MIDDLEWARE_KEY_PREFIX vs KEY_PREFIX Backport of 446b50b90e9e60760618b236d8b0ea75a3b19d5a from master --- docs/ref/settings.txt | 11 +++++++---- docs/topics/cache.txt | 8 +++++--- 2 files changed, 12 insertions(+), 7 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 +`. .. 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 `. This prefix is combined with the +:setting:`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 +`. See :doc:`/topics/cache`. diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index 6ad6276c1e..92410dd90e 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -411,6 +411,8 @@ of 60 seconds, and a maximum capacity of 1000 items:: Invalid arguments are silently ignored, as are invalid values of known arguments. +.. _the-per-site-cache: + The per-site cache ================== @@ -537,9 +539,9 @@ setting for the middleware. It can be used like this:: def my_view(request): ... -The two settings can also be combined. If you specify a ``cache`` *and* -a ``key_prefix``, you will get all the settings of the requested cache -alias, but with the key_prefix overridden. +The ``key_prefix and ``cache`` arguments may be specified together. The +``key_prefix`` argument and the :setting:`KEY_PREFIX ` +specified under :setting:`CACHES` will be concatenated. Specifying per-view cache in the URLconf ----------------------------------------