Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Cleaned up the release notes index page, and added some stub 1.1.2 an…

…d 1.2 release notes.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@11760 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit cf169d9e12720558f3de5fa9cfb5aa3d925f3c57 1 parent f5fefcc
Russell Keith-Magee authored November 23, 2009
2  docs/index.txt
@@ -201,5 +201,5 @@ The Django open-source project
201 201
 
202 202
     * **Django over time:**
203 203
       :ref:`API stability <misc-api-stability>` |
204  
-      :ref:`Release notes <releases-index>` |
  204
+      :ref:`Release notes and upgrading instructions <releases-index>` |
205 205
       :ref:`Deprecation Timeline <internals-deprecation>`
10  docs/ref/contrib/csrf.txt
@@ -46,7 +46,7 @@ To enable CSRF protection for your views, follow these steps:
46 46
        ``django.views.decorators.csrf.csrf_protect`` on particular views you
47 47
        want to protect (see below).
48 48
 
49  
-    2. In any template that uses a POST form, use the ``csrf_token`` tag inside
  49
+    2. In any template that uses a POST form, use the :ttag:`csrf_token` tag inside
50 50
        the ``<form>`` element if the form is for an internal URL, e.g.::
51 51
 
52 52
            <form action="" method="POST">{% csrf_token %}
@@ -123,14 +123,14 @@ as ``CsrfResponseMiddleware``, and it can be used by following these steps:
123 123
 
124 124
        ``CsrfResponseMiddleware`` needs to process the response before things
125 125
        like compression or setting ofETags happen to the response, so it must
126  
-       come after ``GZipMiddleware``, ``CommonMiddleware`` and 
  126
+       come after ``GZipMiddleware``, ``CommonMiddleware`` and
127 127
        ``ConditionalGetMiddleware`` in the list. It also must come after
128 128
        ``CsrfViewMiddleware``.
129 129
 
130 130
 Use of the ``CsrfResponseMiddleware`` is not recommended because of the
131 131
 performance hit it imposes, and because of a potential security problem (see
132 132
 below).  It can be used as an interim measure until applications have been
133  
-updated to use the ``{% csrf_token %}`` tag.  It is deprecated and will be
  133
+updated to use the :ttag:`csrf_token` tag.  It is deprecated and will be
134 134
 removed in Django 1.4.
135 135
 
136 136
 Django 1.1 and earlier provided a single ``CsrfMiddleware`` class.  This is also
@@ -199,7 +199,7 @@ Note that contrib apps, such as the admin, have been updated to use the
199 199
 ``CsrfViewMiddleware`` to your settings.  However, if you have supplied
200 200
 customised templates to any of the view functions of contrib apps (whether
201 201
 explicitly via a keyword argument, or by overriding built-in templates), **you
202  
-MUST update them** to include the ``csrf_token`` template tag as described
  202
+MUST update them** to include the :ttag:`csrf_token` template tag as described
203 203
 above, or they will stop working.  (If you cannot update these templates for
204 204
 some reason, you will be forced to use ``CsrfResponseMiddleware`` for these
205 205
 views to continue working).
@@ -364,7 +364,7 @@ exactly that.
364 364
 Caching
365 365
 =======
366 366
 
367  
-If the ``csrf_token`` template tag is used by a template (or the ``get_token``
  367
+If the :ttag:`csrf_token` template tag is used by a template (or the ``get_token``
368 368
 function is called some other way), ``CsrfViewMiddleware`` will add a cookie and
369 369
 a ``Vary: Cookie`` header to the response.  Similarly,
370 370
 ``CsrfResponseMiddleware`` will send the ``Vary: Cookie`` header if it inserted
4  docs/ref/templates/builtins.txt
@@ -51,7 +51,7 @@ comment
51 51
 
52 52
 Ignore everything between ``{% comment %}`` and ``{% endcomment %}``
53 53
 
54  
-.. templatetag:: cycle
  54
+.. templatetag:: csrf_token
55 55
 
56 56
 csrf_token
57 57
 ~~~~~~~~~~
@@ -63,6 +63,8 @@ future compatibility purposes.  In Django 1.2 and later, it is used for CSRF
63 63
 protection, as described in the documentation for :ref:`Cross Site Request
64 64
 Forgeries <ref-contrib-csrf>`.
65 65
 
  66
+.. templatetag:: cycle
  67
+
66 68
 cycle
67 69
 ~~~~~
68 70
 
36  docs/releases/1.1.2.txt
... ...
@@ -0,0 +1,36 @@
  1
+.. _releases-1.1.2:
  2
+
  3
+==============================================
  4
+Django 1.1.2 release notes — UNDER DEVELOPMENT
  5
+==============================================
  6
+
  7
+This page documents release notes for the as-yet-unreleased Django
  8
+1.1.2. As such it is tentative and subject to change. It provides
  9
+up-to-date information for those who are following the 1.1.X branch.
  10
+
  11
+This is the second "bugfix" release in the Django 1.1 series,
  12
+improving the stability and performance of the Django 1.1 codebase.
  13
+
  14
+Django 1.1.2 maintains backwards compatibility with Django
  15
+1.1.0, but contain a number of fixes and other
  16
+improvements. Django 1.1.2 is a recommended upgrade for any
  17
+development or deployment currently using or targeting Django 1.1.
  18
+
  19
+For full details on the new features, backwards incompatibilities, and
  20
+deprecated features in the 1.1 branch, see the :ref:`releases-1.1`.
  21
+
  22
+One new feature
  23
+---------------
  24
+
  25
+Ordinarily, a point release would not include new features, but in the
  26
+case of Django 1.1.2, we have made an exception to this rule. Django
  27
+1.2 (the next major release of Django) will contain a feature that
  28
+will improve protection against Cross-Site Request Forgery (CSRF)
  29
+attacks. This feature requires the use of a new :ttag:`csrf_token`
  30
+template tag in all forms that Django renders.
  31
+
  32
+To make it easier to support both 1.1.X and 1.2.X versions of Django with
  33
+the same templates, we have decided to introduce the :ttag:`csrf_token` template
  34
+tag to the 1.1.X branch. In the 1.1.X branch, :ttag:`csrf_token` does nothing -
  35
+it has no effect on templates or form processing. However, it means that the
  36
+same template will work with Django 1.2.
39  docs/releases/1.2.txt
@@ -8,6 +8,11 @@ This page documents release notes for the as-yet-unreleased Django 1.2.  As such
8 8
 it is tentative and subject to change.  It provides up-to-date information for
9 9
 those who are following trunk.
10 10
 
  11
+Django 1.2 includes a number of nifty `new features`_, lots of bug
  12
+fixes, and an easy upgrade path from Django 1.1.
  13
+
  14
+.. _new features: `What's new in Django 1.2`_
  15
+
11 16
 .. _backwards-incompatible-changes-1.2:
12 17
 
13 18
 Backwards-incompatible changes in 1.2
@@ -68,3 +73,37 @@ Features deprecated in 1.2
68 73
 ==========================
69 74
 
70 75
 None.
  76
+
  77
+What's new in Django 1.2
  78
+========================
  79
+
  80
+CSRF support
  81
+------------
  82
+
  83
+Django now has much improved protection against :ref:`Cross-Site
  84
+Request Forgery (CSRF) attacks<ref-contrib-csrf>`. This type of attack
  85
+occurs when a malicious Web site contains a link, a form button or
  86
+some javascript that is intended to perform some action on your Web
  87
+site, using the credentials of a logged-in user who visits the
  88
+malicious site in their browser. A related type of attack, 'login
  89
+CSRF', where an attacking site tricks a user's browser into logging
  90
+into a site with someone else's credentials, is also covered.
  91
+
  92
+Email Backends
  93
+--------------
  94
+
  95
+You can now :ref:`configure the way that Django sends email
  96
+<topic-email-backends>`. Instead of using SMTP to send all email, you
  97
+can now choose a configurable email backend to send messages. If your
  98
+hosting provider uses a sandbox or some other non-SMTP technique for
  99
+sending mail, you can now construct an email backend that will allow
  100
+Django's standard :ref:`mail sending methods<topics-email>` to use
  101
+those facilities.
  102
+
  103
+This also makes it easier to debug mail sending - Django ships with
  104
+backend implementations that allow you to send email to a
  105
+:ref:`file<topic-email-file-backend>`, to the
  106
+:ref:`console<topic-email-console-backend>`, or to
  107
+:ref:`memory<topic-email-memory-backend>` - you can even configure all
  108
+email to be :ref:`thrown away<topic-email-console-backend>`.
  109
+
76  docs/releases/index.txt
... ...
@@ -1,5 +1,6 @@
1 1
 .. _releases-index:
2 2
 
  3
+=============
3 4
 Release notes
4 5
 =============
5 6
 
@@ -7,37 +8,60 @@ Release notes for the official Django releases. Each release note will tell you
7 8
 what's new in each version, and will also describe any backwards-incompatible
8 9
 changes made in that version.
9 10
 
  11
+For those upgrading to a new version of Django, you will need to check
  12
+all the backwards-incompatible changes and deprecated features for
  13
+each 'final' release from the one after your current Django version,
  14
+up to and including the new version.
  15
+
  16
+Final releases
  17
+==============
  18
+
  19
+1.2 release
  20
+-----------
10 21
 .. toctree::
11 22
    :maxdepth: 1
12 23
 
13  
-   0.95
14  
-   0.96
15  
-   1.0-alpha-1
16  
-   1.0-alpha-2
17  
-   1.0-beta
18  
-   1.0-beta-2
19  
-   1.0
20  
-   1.0.1
21  
-   1.0.2
22  
-   1.1-alpha-1
23  
-   1.1-beta-1
24  
-   1.1-rc-1
  24
+   1.2
  25
+
  26
+1.1 release
  27
+-----------
  28
+.. toctree::
  29
+   :maxdepth: 1
  30
+
  31
+   1.1.2
25 32
    1.1
26 33
 
27  
-Upgrading
28  
-=========
  34
+1.0 release
  35
+-----------
  36
+.. toctree::
  37
+   :maxdepth: 1
29 38
 
30  
-For those upgrading to a new version of Django, you will need to check all the
31  
-backwards-incompatible changes and deprecated features for each 'final' release
32  
-from the one after your old version up to and including your new version.  The
33  
-relevant sections of the release notes are linked below below for your
34  
-convenience.
  39
+   1.0.2
  40
+   1.0.1
  41
+   1.0
  42
+
  43
+Pre-1.0 releases
  44
+----------------
  45
+.. toctree::
  46
+   :maxdepth: 1
  47
+
  48
+   0.96
  49
+   0.95
  50
+
  51
+Development releases
  52
+====================
35 53
 
36  
-For those following trunk, the tentative release notes for the next version to
37  
-be released are also included at the bottom.  This is kept up to date with new
38  
-features and changes that you need to be aware of.
  54
+These notes are retained for historical purposes. If you are upgrading
  55
+between formal Django releases, you don't need to worry about these
  56
+notes.
39 57
 
40  
- * :ref:`backwards-incompatible-changes-1.1`
41  
- * :ref:`deprecated-features-1.1`
42  
- * :ref:`backwards-incompatible-changes-1.2`
43  
- * :ref:`deprecated-features-1.2`
  58
+.. toctree::
  59
+   :maxdepth: 1
  60
+
  61
+   1.1-rc-1
  62
+   1.1-beta-1
  63
+   1.1-alpha-1
  64
+   1.0-beta-2
  65
+   1.0-beta
  66
+   1.0-alpha-2
  67
+   1.0-alpha-1
8  docs/topics/email.txt
@@ -421,6 +421,8 @@ want to specify it explicitly, put the following in your settings::
421 421
     still available in ``django.core.mail`` as an alias for the SMTP backend.
422 422
     New code should use :meth:`~django.core.mail.get_connection` instead.
423 423
 
  424
+.. _topic-email-console-backend:
  425
+
424 426
 Console backend
425 427
 ~~~~~~~~~~~~~~~
426 428
 
@@ -436,6 +438,8 @@ To specify this backend, put the following in your settings::
436 438
 This backend is not intended for use in production -- it is provided as a
437 439
 convenience that can be used during development.
438 440
 
  441
+.. _topic-email-file-backend:
  442
+
439 443
 File backend
440 444
 ~~~~~~~~~~~~
441 445
 
@@ -453,6 +457,8 @@ To specify this backend, put the following in your settings::
453 457
 This backend is not intended for use in production -- it is provided as a
454 458
 convenience that can be used during development.
455 459
 
  460
+.. _topic-email-memory-backend:
  461
+
456 462
 In-memory backend
457 463
 ~~~~~~~~~~~~~~~~~
458 464
 
@@ -469,6 +475,8 @@ To specify this backend, put the following in your settings::
469 475
 This backend is not intended for use in production -- it is provided as a
470 476
 convenience that can be used during development and testing.
471 477
 
  478
+.. _topic-email-dummy-backend:
  479
+
472 480
 Dummy backend
473 481
 ~~~~~~~~~~~~~
474 482
 

0 notes on commit cf169d9

Please sign in to comment.
Something went wrong with that request. Please try again.