diff options
| author | Tim Graham <timograham@gmail.com> | 2017-09-02 21:09:22 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-09-22 12:51:18 -0400 |
| commit | 48d57788ee56811fa77cd37b9edf40535f82d87e (patch) | |
| tree | 287dccd8f73cc4ef5d0f57eb5607fa1076a75bc0 /docs | |
| parent | 4502489a466b89cccd9d2c1b8d21b2f153d71b4b (diff) | |
Refs #26447 -- Removed the USE_ETAGS setting per deprecation timeline.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/middleware.txt | 16 | ||||
| -rw-r--r-- | docs/ref/settings.txt | 18 | ||||
| -rw-r--r-- | docs/ref/utils.txt | 6 | ||||
| -rw-r--r-- | docs/releases/2.1.txt | 3 |
4 files changed, 3 insertions, 40 deletions
diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt index 5c33d196d3..05f06092aa 100644 --- a/docs/ref/middleware.txt +++ b/docs/ref/middleware.txt @@ -61,23 +61,12 @@ Adds a few conveniences for perfectionists: indexer would treat them as separate URLs -- so it's best practice to normalize URLs. -* Handles ETags based on the :setting:`USE_ETAGS` setting. If - :setting:`USE_ETAGS` is set to ``True``, Django will calculate an ETag - for each request by MD5-hashing the page content, and it'll take care of - sending ``Not Modified`` responses, if appropriate. - * Sets the ``Content-Length`` header for non-streaming responses. .. versionchanged:: 1.11 Older versions didn't set the ``Content-Length`` header. -.. deprecated:: 1.11 - - The :setting:`USE_ETAGS` setting is deprecated in favor of using - :class:`~django.middleware.http.ConditionalGetMiddleware` for ETag - processing. - .. attribute:: CommonMiddleware.response_redirect_class Defaults to :class:`~django.http.HttpResponsePermanentRedirect`. Subclass @@ -472,11 +461,6 @@ Here are some hints about the ordering of various Django middleware classes: After ``UpdateCacheMiddleware``: Modifies ``Vary`` header. -#. :class:`~django.middleware.http.ConditionalGetMiddleware` - - Before ``CommonMiddleware``: uses its ``ETag`` header when - :setting:`USE_ETAGS` = ``True``. - #. :class:`~django.contrib.sessions.middleware.SessionMiddleware` After ``UpdateCacheMiddleware``: Modifies ``Vary`` header. diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 358de5eca0..b9dc61686b 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -2593,23 +2593,6 @@ the correct environment. .. _list of time zones: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones -.. setting:: USE_ETAGS - -``USE_ETAGS`` -------------- - -Default: ``False`` - -A boolean that specifies whether to output the ``ETag`` header. This saves -bandwidth but slows down performance. This is used by the -:class:`~django.middleware.common.CommonMiddleware` and in the :doc:`cache -framework </topics/cache>`. - -.. deprecated:: 1.11 - - This setting is deprecated in favor of using ``ConditionalGetMiddleware``, - which sets an ETag regardless of this setting. - .. setting:: USE_I18N ``USE_I18N`` @@ -3438,7 +3421,6 @@ HTTP * :setting:`SECURE_SSL_HOST` * :setting:`SECURE_SSL_REDIRECT` * :setting:`SIGNING_BACKEND` -* :setting:`USE_ETAGS` * :setting:`USE_X_FORWARDED_HOST` * :setting:`USE_X_FORWARDED_PORT` * :setting:`WSGI_APPLICATION` diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index c9fa10e0e5..596edaa09a 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -52,7 +52,6 @@ need to distinguish caches by the ``Accept-language`` header. Adds some useful headers to the given ``HttpResponse`` object: - * ``ETag`` * ``Expires`` * ``Cache-Control`` @@ -65,11 +64,6 @@ need to distinguish caches by the ``Accept-language`` header. In older versions, the ``Last-Modified`` header was also set. - .. deprecated:: 1.11 - - Since the ``USE_ETAGS`` setting is deprecated, this function won't set - the ``ETag`` header when the deprecation ends in Django 2.1. - .. function:: add_never_cache_headers(response) Adds a ``Cache-Control: max-age=0, no-cache, no-store, must-revalidate`` diff --git a/docs/releases/2.1.txt b/docs/releases/2.1.txt index 5effa6eba9..de7150b7b7 100644 --- a/docs/releases/2.1.txt +++ b/docs/releases/2.1.txt @@ -251,3 +251,6 @@ how to remove usage of these features. as the first positional argument. * The ``django.db.models.permalink()`` decorator is removed. + +* The ``USE_ETAGS`` setting is removed. ``CommonMiddleware`` and + ``django.utils.cache.patch_response_headers()`` no longer set ETags. |
