← Back to branch summary

~ubuntu-branches/ubuntu/utopic/python-django/utopic

« back to all changes in this revision

Viewing changes to docs/intro/whatsnext.txt

  • Committer: Package Import Robot
  • Author(s): Raphaël Hertzog
  • Date: 2012-08-02 10:44:02 UTC
  • mfrom: (1.1.17) (4.4.20 sid)
  • Revision ID: package-import@ubuntu.com-20120802104402-x26ethgm9s21la1y
http://bugs.debian.org/683364
* New upstream security and maintenance release. Closes: #683364
  Fixes: CVE-2012-3442 CVE-2012-3443 CVE-2012-3444
* Drop 01_disable_broken_test.diff and 04_hyphen-manpage.diff which
  have been merged upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/intro/whatsnext.txt
93
93
  Django APIs or behaviors change.
94
94
 
95
95
Django's documentation is kept in the same source control system as its code. It
96
 
lives in the `django/trunk/docs`_ directory of our Subversion repository. Each
97
 
document online is a separate text file in the repository.
 
96
lives in the `docs`_ directory of our Git repository. Each document online is a
 
97
separate text file in the repository.
98
98
 
99
 
.. _django/trunk/docs: https://code.djangoproject.com/browser/django/trunk/docs
 
99
.. _docs: https://github.com/django/django/tree/master/docs
100
100
 
101
101
Where to get it
102
102
===============
138
138
(tarball) of the code includes a ``docs/`` directory, which contains all the
139
139
documentation for that release.
140
140
 
141
 
If you're using the development version of Django (aka the Subversion "trunk"),
142
 
note that the ``docs/`` directory contains all of the documentation. You can
143
 
``svn update`` it, just as you ``svn update`` the Python code, in order to get
144
 
the latest changes.
145
 
 
146
 
You can check out the latest Django documentation from Subversion using this
147
 
shell command:
148
 
 
149
 
.. code-block:: bash
150
 
 
151
 
    $ svn co https://code.djangoproject.com/svn/django/trunk/docs/ django_docs
 
141
If you're using the development version of Django (aka "trunk"), note that the
 
142
``docs/`` directory contains all of the documentation. You can update your
 
143
Git checkout to get the latest changes.
152
144
 
153
145
One low-tech way of taking advantage of the text documentation is by using the
154
146
Unix ``grep`` utility to search for a phrase in all of the documentation. For
202
194
Differences between versions
203
195
============================
204
196
 
205
 
As previously mentioned, the text documentation in our Subversion repository
 
197
As previously mentioned, the text documentation in our Git repository
206
198
contains the "latest and greatest" changes and additions. These changes often
207
199
include documentation of new features added in the Django development version
 
200
-- the Git ("trunk") version of Django. For that reason, it's worth
208
201
pointing out our policy on keeping straight the documentation for various
209
202
versions of the framework.
210
203
 
211
204
We follow this policy:
212
205
 
213
206
* The primary documentation on djangoproject.com is an HTML version of the
214
 
  latest docs in Subversion. These docs always correspond to the latest
 
207
  latest docs in Git. These docs always correspond to the latest
215
208
  official Django release, plus whatever features we've added/changed in
216
209
  the framework *since* the latest release.
217
210
 
218
211
* As we add features to Django's development version, we try to update the
219
 
  documentation in the same Subversion commit transaction.
 
212
  documentation in the same Git commit transaction.
220
213
 
221
214
* To distinguish feature changes/additions in the docs, we use the phrase:
222
215
  "New in version X.Y", being X.Y the next release version (hence, the one