Clarified migration plan in docs/newforms.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5216 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
d362799721
commit
3d86329f82
|
@ -9,28 +9,30 @@ framework. This document explains how to use this new library.
|
|||
Migration plan
|
||||
==============
|
||||
|
||||
``django.newforms`` currently is only available in Django beginning
|
||||
with the 0.96 release. the Django development version -- i.e., it's
|
||||
not available in the Django 0.95 release. For the next Django release,
|
||||
our plan is to do the following:
|
||||
``django.newforms`` is new in Django's 0.96 release, but, as it won't be new
|
||||
forever, we plan to rename the ``django.newforms`` package to ``django.forms``
|
||||
in the future. The current ``django.forms`` package will be available as
|
||||
``django.oldforms``.
|
||||
|
||||
* As of revision [4208], we've copied the current ``django.forms`` to
|
||||
``django.oldforms``. This allows you to upgrade your code *now* rather
|
||||
than waiting for the backwards-incompatible change and rushing to fix
|
||||
your code after the fact. Just change your import statements like this::
|
||||
That has direct repercussions on the forward compatibility of your code. Please
|
||||
read the following migration plan and code accordingly:
|
||||
|
||||
* The old forms framework (the current ``django.forms``) has been copied to
|
||||
``django.oldforms``. Thus, you can start upgrading your code *now*,
|
||||
rather than waiting for the future backwards-incompatible change, by
|
||||
changing your import statements like this::
|
||||
|
||||
from django import forms # old
|
||||
from django import oldforms as forms # new
|
||||
|
||||
* At an undecided future date, we will move the current ``django.newforms``
|
||||
to ``django.forms``. This will be a backwards-incompatible change, and
|
||||
anybody who is still using the old version of ``django.forms`` at that
|
||||
time will need to change their import statements, as described in the
|
||||
previous bullet.
|
||||
* In the next Django release (0.97), we will move the current
|
||||
``django.newforms`` to ``django.forms``. This will be a
|
||||
backwards-incompatible change, and anybody who is still using the old
|
||||
version of ``django.forms`` at that time will need to change their import
|
||||
statements, as described in the previous bullet.
|
||||
|
||||
* We will remove ``django.oldforms`` in the release *after* the next Django
|
||||
release -- the release that comes after the release in which we're
|
||||
creating the new ``django.forms``.
|
||||
release -- either 0.98 or 1.0, whichever comes first.
|
||||
|
||||
With this in mind, we recommend you use the following import statement when
|
||||
using ``django.newforms``::
|
||||
|
|
Loading…
Reference in New Issue