Fixed #19518 -- Documented the deprecation of localflavor.

Also moved the contrib deprecations at the top of their section and made
minor markup fixes.
This commit is contained in:
Aymeric Augustin 2012-12-26 14:19:28 +01:00
parent 0907d3c6f5
commit 4500d3522d
3 changed files with 37 additions and 14 deletions

View File

@ -14,7 +14,7 @@ See the :doc:`Django 1.2 release notes</releases/1.2>` for more details on
these changes. these changes.
* ``CsrfResponseMiddleware`` and ``CsrfMiddleware`` will be removed. Use * ``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. protection. ``CsrfViewMiddleware`` remains and is enabled by default.
* The old imports for CSRF functionality (``django.contrib.csrf.*``), * The old imports for CSRF functionality (``django.contrib.csrf.*``),
@ -200,6 +200,14 @@ these changes.
See the :doc:`Django 1.4 release notes</releases/1.4>` for more details on See the :doc:`Django 1.4 release notes</releases/1.4>` for more details on
these changes. 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 * The compatibility modules ``django.utils.copycompat`` and
``django.utils.hashcompat`` as well as the functions ``django.utils.hashcompat`` as well as the functions
``django.utils.itercompat.all`` and ``django.utils.itercompat.any`` will ``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 :data:`~django.conf.urls.handler500`, are now available through
:mod:`django.conf.urls` . :mod:`django.conf.urls` .
* The Databrowse contrib module will be removed.
* The functions :func:`~django.core.management.setup_environ` and * The functions :func:`~django.core.management.setup_environ` and
:func:`~django.core.management.execute_manager` will be removed from :func:`~django.core.management.execute_manager` will be removed from
:mod:`django.core.management`. This also means that the old (pre-1.4) :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 -- in 1.4. The backward compatibility will be removed --
``HttpRequest.raw_post_data`` will no longer work. ``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 * The value for the ``post_url_continue`` parameter in
``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect ``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect

View File

@ -37,6 +37,8 @@ file.
.. _ISO 3166 country code: http://www.iso.org/iso/country_codes.htm .. _ISO 3166 country code: http://www.iso.org/iso/country_codes.htm
.. _localflavor-how-to-migrate:
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 so you don't have to worry about backwards compatibility in terms of
functionality. Only the imports have changed. functionality. Only the imports have changed.
.. _localflavor-deprecation-policy:
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 In Django 1.6, importing from ``django.contrib.localflavor`` will no longer
work. work.
.. _localflavor-packages:
Supported countries Supported countries
=================== ===================

View File

@ -634,7 +634,26 @@ Miscellaneous
Features deprecated in 1.5 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 <localflavor-deprecation-policy>`. The docs
provide :ref:`migration instructions <localflavor-how-to-migrate>`.
The new packages are available :ref:`on Github <localflavor-packages>`. 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` :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 In Django 1.7 and above, the iterator will be consumed immediately by
:class:`~django.http.HttpResponse`. :class:`~django.http.HttpResponse`.
.. _simplejson-deprecation:
``django.utils.simplejson`` ``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 :func:`~django.utils.itercompat.product` function has been deprecated. Use
the built-in :func:`itertools.product` instead. 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 ``cleanup`` management command
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~