← Back to branch summary

~ubuntu-branches/ubuntu/quantal/python-django/quantal-security

« back to all changes in this revision

Viewing changes to docs/misc/api-stability.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Strandboge
  • Date: 2010-10-12 11:34:35 UTC
  • mfrom: (1.1.12 upstream) (29.1.1 maverick-security)
  • Revision ID: james.westby@ubuntu.com-20101012113435-yy57c8tx6g9anf3e
Tags: 1.2.3-1ubuntu0.1
* SECURITY UPDATE: XSS in CSRF protections. New upstream release
  - CVE-2010-3082
* debian/patches/01_disable_url_verify_regression_tests.diff:
  - updated to disable another test that fails without internet connection
  - patch based on work by Kai Kasurinen and Krzysztof Klimonda
* debian/control: don't Build-Depends on locales-all, which doesn't exist
  in maverick

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/misc/api-stability.txt
1
 
.. _misc-api-stability:
2
 
 
3
1
=============
4
2
API stability
5
3
=============
6
4
 
7
 
:ref:`The release of Django 1.0 <releases-1.0>` comes with a promise of API
 
5
:doc:`The release of Django 1.0 </releases/1.0>` comes with a promise of API
8
6
stability and forwards-compatibility. In a nutshell, this means that code you
9
7
develop against Django 1.0 will continue to work against 1.1 unchanged, and you
10
8
should need to make only minor changes for any 1.X release.
37
35
===========
38
36
 
39
37
In general, everything covered in the documentation -- with the exception of
40
 
anything in the :ref:`internals area <internals-index>` is considered stable as
 
38
anything in the :doc:`internals area </internals/index>` is considered stable as
41
39
of 1.0. This includes these APIs:
42
40
 
43
 
    - :ref:`Authorization <topics-auth>`
 
41
    - :doc:`Authorization </topics/auth>`
44
42
 
45
 
    - :ref:`Caching <topics-cache>`.
46
 
    
47
 
    - :ref:`Model definition, managers, querying and transactions
48
 
      <topics-db-index>`
49
 
    
50
 
    - :ref:`Sending e-mail <topics-email>`.
51
 
    
52
 
    - :ref:`File handling and storage <topics-files>`
53
 
    
54
 
    - :ref:`Forms <topics-forms-index>`
55
 
    
56
 
    - :ref:`HTTP request/response handling <topics-http-index>`, including file
 
43
    - :doc:`Caching </topics/cache>`.
 
44
    
 
45
    - :doc:`Model definition, managers, querying and transactions
 
46
      </topics/db/index>`
 
47
    
 
48
    - :doc:`Sending e-mail </topics/email>`.
 
49
    
 
50
    - :doc:`File handling and storage </topics/files>`
 
51
    
 
52
    - :doc:`Forms </topics/forms/index>`
 
53
    
 
54
    - :doc:`HTTP request/response handling </topics/http/index>`, including file
57
55
      uploads, middleware, sessions, URL resolution, view, and shortcut APIs.
58
56
    
59
 
    - :ref:`Generic views <topics-http-generic-views>`.
 
57
    - :doc:`Generic views </topics/http/generic-views>`.
60
58
 
61
 
    - :ref:`Internationalization <topics-i18n>`.
62
 
    
63
 
    - :ref:`Pagination <topics-pagination>`
64
 
    
65
 
    - :ref:`Serialization <topics-serialization>`
66
 
    
67
 
    - :ref:`Signals <topics-signals>`
68
 
    
69
 
    - :ref:`Templates <topics-templates>`, including the language, Python-level
70
 
      :ref:`template APIs <ref-templates-index>`, and :ref:`custom template tags
71
 
      and libraries <howto-custom-template-tags>`. We may add new template
 
59
    - :doc:`Internationalization </topics/i18n/index>`.
 
60
    
 
61
    - :doc:`Pagination </topics/pagination>`
 
62
    
 
63
    - :doc:`Serialization </topics/serialization>`
 
64
    
 
65
    - :doc:`Signals </topics/signals>`
 
66
    
 
67
    - :doc:`Templates </topics/templates>`, including the language, Python-level
 
68
      :doc:`template APIs </ref/templates/index>`, and :doc:`custom template tags
 
69
      and libraries </howto/custom-template-tags>`. We may add new template
72
70
      tags in the future and the names may inadvertently clash with
73
71
      external template tags. Before adding any such tags, we'll ensure that
74
72
      Django raises an error if it tries to load tags with duplicate names.
75
73
      
76
 
    - :ref:`Testing <topics-testing>`
 
74
    - :doc:`Testing </topics/testing>`
77
75
 
78
 
    - :ref:`django-admin utility <ref-django-admin>`.
79
 
    
80
 
    - :ref:`Built-in middleware <ref-middleware>`
81
 
    
82
 
    - :ref:`Request/response objects <ref-request-response>`.
83
 
    
84
 
    - :ref:`Settings <ref-settings>`. Note, though that while the :ref:`list of
85
 
      built-in settings <ref-settings>` can be considered complete we may -- and
 
76
    - :doc:`django-admin utility </ref/django-admin>`.
 
77
    
 
78
    - :doc:`Built-in middleware </ref/middleware>`
 
79
    
 
80
    - :doc:`Request/response objects </ref/request-response>`.
 
81
    
 
82
    - :doc:`Settings </ref/settings>`. Note, though that while the :doc:`list of
 
83
      built-in settings </ref/settings>` can be considered complete we may -- and
86
84
      probably will -- add new settings in future versions. This is one of those
87
85
      places where "'stable' does not mean 'complete.'"
88
86
      
89
 
    - :ref:`Built-in signals <ref-signals>`. Like settings, we'll probably add
 
87
    - :doc:`Built-in signals </ref/signals>`. Like settings, we'll probably add
90
88
      new signals in the future, but the existing ones won't break.
91
89
      
92
 
    - :ref:`Unicode handling <ref-unicode>`.
 
90
    - :doc:`Unicode handling </ref/unicode>`.
93
91
        
94
 
    - Everything covered by the :ref:`HOWTO guides <howto-index>`.
 
92
    - Everything covered by the :doc:`HOWTO guides </howto/index>`.
95
93
    
96
94
``django.utils``
97
95
----------------
98
96
 
99
97
Most of the modules in ``django.utils`` are designed for internal use. Only
100
 
the following parts of :ref:`django.utils <ref-utils>` can be considered stable:
 
98
the following parts of :doc:`django.utils </ref/utils>` can be considered stable:
101
99
 
102
100
    - ``django.utils.cache``
103
101
    - ``django.utils.datastructures.SortedDict`` -- only this single class; the