From 4500d3522defd7df869756e8ee2c876a747a8fa9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 26 Dec 2012 14:19:28 +0100 Subject: [PATCH] Fixed #19518 -- Documented the deprecation of localflavor. Also moved the contrib deprecations at the top of their section and made minor markup fixes. --- docs/internals/deprecation.txt | 14 +++++++++----- docs/ref/contrib/localflavor.txt | 6 ++++++ docs/releases/1.5.txt | 31 ++++++++++++++++++++++--------- 3 files changed, 37 insertions(+), 14 deletions(-) diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 386dfc0b00..77f03ae2c7 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -14,7 +14,7 @@ See the :doc:`Django 1.2 release notes` for more details on these changes. * ``CsrfResponseMiddleware`` and ``CsrfMiddleware`` will be removed. Use - the {% csrf_token %} template tag inside forms to enable CSRF + the ``{% csrf_token %}`` template tag inside forms to enable CSRF protection. ``CsrfViewMiddleware`` remains and is enabled by default. * The old imports for CSRF functionality (``django.contrib.csrf.*``), @@ -200,6 +200,14 @@ these changes. See the :doc:`Django 1.4 release notes` for more details on these changes. +* ``django.contrib.databrowse`` will be removed. + +* ``django.contrib.localflavor`` will be removed following an accelerated + deprecation. + +* ``django.contrib.markup`` will be removed following an accelerated + deprecation. + * The compatibility modules ``django.utils.copycompat`` and ``django.utils.hashcompat`` as well as the functions ``django.utils.itercompat.all`` and ``django.utils.itercompat.any`` will @@ -251,8 +259,6 @@ these changes. :data:`~django.conf.urls.handler500`, are now available through :mod:`django.conf.urls` . -* The Databrowse contrib module will be removed. - * The functions :func:`~django.core.management.setup_environ` and :func:`~django.core.management.execute_manager` will be removed from :mod:`django.core.management`. This also means that the old (pre-1.4) @@ -265,8 +271,6 @@ these changes. in 1.4. The backward compatibility will be removed -- ``HttpRequest.raw_post_data`` will no longer work. -* ``django.contrib.markup`` will be removed following an accelerated - deprecation. * The value for the ``post_url_continue`` parameter in ``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect diff --git a/docs/ref/contrib/localflavor.txt b/docs/ref/contrib/localflavor.txt index 9bb27e6e74..84569feebe 100644 --- a/docs/ref/contrib/localflavor.txt +++ b/docs/ref/contrib/localflavor.txt @@ -37,6 +37,8 @@ file. .. _ISO 3166 country code: http://www.iso.org/iso/country_codes.htm +.. _localflavor-how-to-migrate: + How to migrate ============== @@ -60,6 +62,8 @@ The code in the new packages is the same (it was copied directly from Django), so you don't have to worry about backwards compatibility in terms of functionality. Only the imports have changed. +.. _localflavor-deprecation-policy: + Deprecation policy ================== @@ -70,6 +74,8 @@ change it as soon as possible. In Django 1.6, importing from ``django.contrib.localflavor`` will no longer work. +.. _localflavor-packages: + Supported countries =================== diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt index 6ac5120617..8259c12cb4 100644 --- a/docs/releases/1.5.txt +++ b/docs/releases/1.5.txt @@ -634,7 +634,26 @@ Miscellaneous Features deprecated in 1.5 ========================== -.. _simplejson-deprecation: +``django.contrib.localflavor`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The localflavor contrib app has been split into separate packages. +``django.contrib.localflavor`` itself will be removed in Django 1.6, after an +:ref:`accelerated deprecation `. The docs +provide :ref:`migration instructions `. + +The new packages are available :ref:`on Github `. The +core team cannot efficiently maintain these packages in the long term — it +spans just a dozen countries at this time; similar to translations, maintenance +will be handed over to interested members of the community. + +``django.contrib.markup`` +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The markup contrib module has been deprecated and will follow an accelerated +deprecation schedule. Direct use of python markup libraries or 3rd party tag +libraries is preferred to Django maintaining this functionality in the +framework. :setting:`AUTH_PROFILE_MODULE` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -660,6 +679,8 @@ to :class:`~django.http.HttpResponse`. If you rely on this behavior, switch to In Django 1.7 and above, the iterator will be consumed immediately by :class:`~django.http.HttpResponse`. +.. _simplejson-deprecation: + ``django.utils.simplejson`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -687,14 +708,6 @@ Define a ``__str__`` method and apply the The :func:`~django.utils.itercompat.product` function has been deprecated. Use the built-in :func:`itertools.product` instead. -``django.utils.markup`` -~~~~~~~~~~~~~~~~~~~~~~~ - -The markup contrib module has been deprecated and will follow an accelerated -deprecation schedule. Direct use of python markup libraries or 3rd party tag -libraries is preferred to Django maintaining this functionality in the -framework. - ``cleanup`` management command ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~