summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/authentication.txt2
-rw-r--r--docs/cache.txt8
-rw-r--r--docs/db-api.txt2
-rw-r--r--docs/distributions.txt35
-rw-r--r--docs/django-admin.txt3
-rw-r--r--docs/modpython.txt3
-rw-r--r--docs/templates.txt12
-rw-r--r--docs/testing.txt29
-rw-r--r--docs/tutorial01.txt4
9 files changed, 65 insertions, 33 deletions
diff --git a/docs/authentication.txt b/docs/authentication.txt
index 7860b59d7d..131a8930b5 100644
--- a/docs/authentication.txt
+++ b/docs/authentication.txt
@@ -190,7 +190,7 @@ function that comes with Django::
>>> from django.contrib.auth.models import User
>>> user = User.objects.create_user('john', 'lennon@thebeatles.com', 'johnpassword')
- # At this point, user is a User object ready to be saved
+ # At this point, user is a User object that has already been saved
# to the database. You can continue to change its attributes
# if you want to change other fields.
>>> user.is_staff = True
diff --git a/docs/cache.txt b/docs/cache.txt
index d13352b025..92b5c1b43d 100644
--- a/docs/cache.txt
+++ b/docs/cache.txt
@@ -176,9 +176,11 @@ just implements the cache interface without doing anything.
This is useful if you have a production site that uses heavy-duty caching in
various places but a development/test environment on which you don't want to
-cache. In that case, set ``CACHE_BACKEND`` to ``"dummy:///"`` in the settings
-file for your development environment. As a result, your development
-environment won't use caching and your production environment still will.
+cache. As a result, your development environment won't use caching and your
+production environment still will. To activate dummy caching, set
+``CACHE_BACKEND`` like so::
+
+ CACHE_BACKEND = 'dummy:///'
CACHE_BACKEND arguments
-----------------------
diff --git a/docs/db-api.txt b/docs/db-api.txt
index 3198f335c4..2a90b2d171 100644
--- a/docs/db-api.txt
+++ b/docs/db-api.txt
@@ -160,7 +160,7 @@ When you save an object, Django performs the following steps:
is used to provide notification that an object has been successfully
saved. (These signals are not yet documented.)
-Raw Saves
+Raw saves
~~~~~~~~~
**New in Django development version**
diff --git a/docs/distributions.txt b/docs/distributions.txt
index f9b9cbe9f8..d65e047276 100644
--- a/docs/distributions.txt
+++ b/docs/distributions.txt
@@ -15,6 +15,18 @@ repository.
.. _installing the development version: ../install/#installing-the-development-version
+FreeBSD
+=======
+
+The `FreeBSD`_ ports system offers both Django 0.96 (`py-django`_) and a more
+recent, but not current, version based on Django's trunk (`py-django-devel`_).
+These are installed in the normal FreeBSD way; for Django 0.96, for example, type:
+``cd /usr/ports/www/py-django && sudo make install clean``.
+
+.. _FreeBSD: http://www.freebsd.org/
+.. _py-django: http://www.freebsd.org/cgi/cvsweb.cgi/ports/www/py-django/
+.. _py-django-devel: http://www.freebsd.org/cgi/cvsweb.cgi/ports/www/py-django-devel/
+
Linux distributions
===================
@@ -33,17 +45,6 @@ plan to use with Django.
.. _Debian GNU/Linux: http://www.debian.org/
.. _packaged version of Django: http://packages.debian.org/stable/python/python-django
-Ubuntu
-------
-
-The Debian ``python-django`` package is also available for `Ubuntu Linux`_, in
-the "universe" repository for Ubuntu 7.04 ("Feisty Fawn"). The `current Ubuntu
-package`_ is also based on Django 0.95.1 and can be installed in the same
-fashion as for Debian.
-
-.. _Ubuntu Linux: http://www.ubuntu.com/
-.. _current Ubuntu package: http://packages.ubuntu.com/feisty/python/python-django
-
Fedora
------
@@ -65,6 +66,18 @@ The `current Gentoo build`_ can be installed by typing ``emerge django``.
.. _Gentoo Linux: http://www.gentoo.org/
.. _current Gentoo build: http://packages.gentoo.org/packages/?category=dev-python;name=django
+Ubuntu
+------
+
+The Debian ``python-django`` package is also available for `Ubuntu Linux`_, in
+the "universe" repository for Ubuntu 7.04 ("Feisty Fawn"). The `current Ubuntu
+package`_ is also based on Django 0.95.1 and can be installed in the same
+fashion as for Debian.
+
+.. _Ubuntu Linux: http://www.ubuntu.com/
+.. _current Ubuntu package: http://packages.ubuntu.com/feisty/python/python-django
+
+
Mac OS X
========
diff --git a/docs/django-admin.txt b/docs/django-admin.txt
index 366483a47a..e3d1067dd3 100644
--- a/docs/django-admin.txt
+++ b/docs/django-admin.txt
@@ -479,6 +479,9 @@ This is useful in a number of ways:
Note that this server can only run on the default port on localhost; it does
not yet accept a ``host`` or ``port`` parameter.
+Also note that it does *not* automatically detect changes to your Python source
+code (as ``runserver`` does). It does, however, detect changes to templates.
+
.. _unit tests: ../testing/
validate
diff --git a/docs/modpython.txt b/docs/modpython.txt
index c90296bd9a..5a1a3f0506 100644
--- a/docs/modpython.txt
+++ b/docs/modpython.txt
@@ -262,7 +262,8 @@ else. This is done using the PythonImport_ directive to mod_python. You need
to ensure that you have specified the ``PythonInterpreter`` directive to
mod_python as described above__ (you need to do this even if you aren't
serving multiple installations in this case). Then add the ``PythonImport``
-line inside the ``Location`` or ``VirtualHost`` section. For example::
+line in the main server configuration (i.e., outside the ``Location`` or
+``VirtualHost`` sections). For example::
PythonInterpreter my_django
PythonImport /path/to/my/project/file.py my_django
diff --git a/docs/templates.txt b/docs/templates.txt
index 6cebd3b7bd..8bfa40dc5f 100644
--- a/docs/templates.txt
+++ b/docs/templates.txt
@@ -1301,9 +1301,14 @@ unordered_list
Recursively takes a self-nested list and returns an HTML unordered list --
WITHOUT opening and closing <ul> tags.
+**Changed in Django development version**
+
+The format accepted by ``unordered_list`` has changed to an easier to
+understand format.
+
The list is assumed to be in the proper format. For example, if ``var`` contains
-``['States', [['Kansas', [['Lawrence', []], ['Topeka', []]]], ['Illinois', []]]]``,
-then ``{{ var|unordered_list }}`` would return::
+``['States', ['Kansas', ['Lawrence', 'Topeka'], 'Illinois']]``, then
+``{{ var|unordered_list }}`` would return::
<li>States
<ul>
@@ -1317,6 +1322,9 @@ then ``{{ var|unordered_list }}`` would return::
</ul>
</li>
+Note: the previous more restrictive and verbose format is still supported:
+``['States', [['Kansas', [['Lawrence', []], ['Topeka', []]]], ['Illinois', []]]]``,
+
upper
~~~~~
diff --git a/docs/testing.txt b/docs/testing.txt
index e27479cc34..22a7e48a7a 100644
--- a/docs/testing.txt
+++ b/docs/testing.txt
@@ -577,13 +577,25 @@ Specifically, a ``Response`` object has the following attributes:
=============== ==========================================================
Attribute Description
=============== ==========================================================
- ``status_code`` The HTTP status of the response, as an integer. See
- RFC2616_ for a full list of HTTP status codes.
+ ``client`` The test client that was used to make the request that
+ resulted in the response.
``content`` The body of the response, as a string. This is the final
page content as rendered by the view, or any error
message (such as the URL for a 302 redirect).
+ ``context`` The template ``Context`` instance that was used to render
+ the template that produced the response content.
+
+ If the rendered page used multiple templates, then
+ ``context`` will be a list of ``Context``
+ objects, in the order in which they were rendered.
+
+ ``request`` The request data that stimulated the response.
+
+ ``status_code`` The HTTP status of the response, as an integer. See
+ RFC2616_ for a full list of HTTP status codes.
+
``template`` The ``Template`` instance that was used to render the
final content. Use ``template.name`` to get the
template's file name, if the template was loaded from a
@@ -594,13 +606,6 @@ Specifically, a ``Response`` object has the following attributes:
using `template inheritance`_ -- then ``template`` will
be a list of ``Template`` instances, in the order in
which they were rendered.
-
- ``context`` The template ``Context`` instance that was used to render
- the template that produced the response content.
-
- As with ``template``, if the rendered page used multiple
- templates, then ``context`` will be a list of ``Context``
- objects, in the order in which they were rendered.
=============== ==========================================================
.. _RFC2616: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
@@ -826,10 +831,10 @@ useful for testing Web applications:
Asserts that the template with the given name was *not* used in rendering
the response.
-``assertRedirects(response, expected_path, status_code=302, target_status_code=200)``
+``assertRedirects(response, expected_url, status_code=302, target_status_code=200)``
Asserts that the response return a ``status_code`` redirect status,
- it redirected to ``expected_path`` and the subsequent page was received with
- ``target_status_code``.
+ it redirected to ``expected_url`` (including any GET data), and the subsequent
+ page was received with ``target_status_code``.
``assertTemplateUsed(response, template_name)``
Asserts that the template with the given name was used in rendering the
diff --git a/docs/tutorial01.txt b/docs/tutorial01.txt
index 65ea7503d7..77b5b11103 100644
--- a/docs/tutorial01.txt
+++ b/docs/tutorial01.txt
@@ -259,7 +259,7 @@ These concepts are represented by simple Python classes. Edit the
choice = models.CharField(max_length=200)
votes = models.IntegerField()
-.. adminition:: Errors about ``max_length``
+.. admonition:: Errors about ``max_length``
If Django gives you an error message saying that ``max_length`` is
not a valid argument, you're most likely using an old version of
@@ -383,7 +383,7 @@ Note the following:
the SQL to the database.
If you're interested, also run the following commands:
- * ``python manage.py validate polls`` -- Checks for any errors in the
+ * ``python manage.py validate`` -- Checks for any errors in the
construction of your models.
* ``python manage.py sqlcustom polls`` -- Outputs any custom SQL statements