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:
Adrian Holovaty 2007-05-14 02:20:12 +00:00
parent d362799721
commit 3d86329f82
1 changed files with 17 additions and 15 deletions

View File

@ -9,28 +9,30 @@ framework. This document explains how to use this new library.
Migration plan Migration plan
============== ==============
``django.newforms`` currently is only available in Django beginning ``django.newforms`` is new in Django's 0.96 release, but, as it won't be new
with the 0.96 release. the Django development version -- i.e., it's forever, we plan to rename the ``django.newforms`` package to ``django.forms``
not available in the Django 0.95 release. For the next Django release, in the future. The current ``django.forms`` package will be available as
our plan is to do the following: ``django.oldforms``.
* As of revision [4208], we've copied the current ``django.forms`` to That has direct repercussions on the forward compatibility of your code. Please
``django.oldforms``. This allows you to upgrade your code *now* rather read the following migration plan and code accordingly:
than waiting for the backwards-incompatible change and rushing to fix
your code after the fact. Just change your import statements like this:: * 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 forms # old
from django import oldforms as forms # new from django import oldforms as forms # new
* At an undecided future date, we will move the current ``django.newforms`` * In the next Django release (0.97), we will move the current
to ``django.forms``. This will be a backwards-incompatible change, and ``django.newforms`` to ``django.forms``. This will be a
anybody who is still using the old version of ``django.forms`` at that backwards-incompatible change, and anybody who is still using the old
time will need to change their import statements, as described in the version of ``django.forms`` at that time will need to change their import
previous bullet. statements, as described in the previous bullet.
* We will remove ``django.oldforms`` in the release *after* the next Django * We will remove ``django.oldforms`` in the release *after* the next Django
release -- the release that comes after the release in which we're release -- either 0.98 or 1.0, whichever comes first.
creating the new ``django.forms``.
With this in mind, we recommend you use the following import statement when With this in mind, we recommend you use the following import statement when
using ``django.newforms``:: using ``django.newforms``::