diff options
| author | Markus Bertheau <mbertheau@gmail.com> | 2015-04-27 23:56:02 +0200 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2015-04-28 12:07:02 -0400 |
| commit | 4a438e400b7ce0ab9d0b6876196cbe8d620a4171 (patch) | |
| tree | cce5d4a9271ad302eea2ff348b40b738f297dcf5 /docs | |
| parent | 82162b4499fc3b83b626c24386e4e5245191d13e (diff) | |
Fixed #13008 -- Added more Cache-Control headers to never_cache() decorator.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/admin/index.txt | 2 | ||||
| -rw-r--r-- | docs/ref/utils.txt | 8 | ||||
| -rw-r--r-- | docs/releases/1.9.txt | 4 | ||||
| -rw-r--r-- | docs/topics/cache.txt | 2 | ||||
| -rw-r--r-- | docs/topics/http/decorators.txt | 19 |
5 files changed, 32 insertions, 3 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index d6a5312e73..85fc4cb6ff 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -1474,7 +1474,7 @@ templates used by the :class:`ModelAdmin` views: url(r'^my_view/$', self.admin_site.admin_view(self.my_view)) This wrapping will protect ``self.my_view`` from unauthorized access and - will apply the ``django.views.decorators.cache.never_cache`` decorator to + will apply the :func:`django.views.decorators.cache.never_cache` decorator to make sure it is not cached if the cache middleware is active. If the page is cacheable, but you still want the permission check to be diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index 18312957fc..7912edd5ce 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -65,7 +65,13 @@ need to distinguish caches by the ``Accept-language`` header. .. function:: add_never_cache_headers(response) - Adds headers to a response to indicate that a page should never be cached. + Adds a ``Cache-Control: max-age=0, no-cache, no-store, must-revalidate`` + header to a response to indicate that a page should never be cached. + + .. versionchanged:: 1.9 + + Before Django 1.9, ``Cache-Control: max-age=0`` was sent. This didn't + reliably prevent caching in all browsers. .. function:: patch_vary_headers(response, newheaders) diff --git a/docs/releases/1.9.txt b/docs/releases/1.9.txt index 21df59f051..cceb0611b5 100644 --- a/docs/releases/1.9.txt +++ b/docs/releases/1.9.txt @@ -118,6 +118,10 @@ Cache * ``django.core.cache.backends.base.BaseCache`` now has a ``get_or_set()`` method. +* :func:`django.views.decorators.cache.never_cache` now sends more persuasive + headers (added ``no-cache, no-store, must-revalidate`` to ``Cache-Control``) + to better prevent caching. + Email ^^^^^ diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index ee8c30cfef..109bcc41ff 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -1209,7 +1209,7 @@ the value of the :setting:`CACHE_MIDDLEWARE_SECONDS` setting. If you use a custo precedence, and the header values will be merged correctly.) If you want to use headers to disable caching altogether, -``django.views.decorators.cache.never_cache`` is a view decorator that adds +:func:`django.views.decorators.cache.never_cache` is a view decorator that adds headers to ensure the response won't be cached by browsers or other caches. Example:: diff --git a/docs/topics/http/decorators.txt b/docs/topics/http/decorators.txt index 25616a44c0..a310576fd5 100644 --- a/docs/topics/http/decorators.txt +++ b/docs/topics/http/decorators.txt @@ -97,3 +97,22 @@ caching based on specific request headers. into account when building its cache key. See :ref:`using vary headers <using-vary-headers>`. + +.. module:: django.views.decorators.cache + +Caching +======= + +The decorators in :mod:`django.views.decorators.cache` control server and +client-side caching. + +.. function:: never_cache(view_func) + + This decorator adds a ``Cache-Control: max-age=0, no-cache, no-store, + must-revalidate`` header to a response to indicate that a page should never + be cached. + + .. versionchanged:: 1.9 + + Before Django 1.9, ``Cache-Control: max-age=0`` was sent. This didn't + reliably prevent caching in all browsers. |
