Skip to content

Commit

Permalink
Documentation (and some small source code) edits from [17432] - [17537]
Browse files Browse the repository at this point in the history 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@17540 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
@adrianholovaty
adrianholovaty committed Feb 17, 2012
1 parent 9fa536d commit 7981efe
Show file tree
Hide file tree
Showing 12 changed files with 139 additions and 141 deletions.
5 changes: 2 additions & 3 deletions django/core/management/validation.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,9 +283,8 @@ def get_validation_errors(outfile, app=None):
# this format would be nice, but it's a little fiddly).
if '__' in field_name:
continue
# Skip ordering on pk, this is always a valid order_by field
# but is an alias and therefore won't be found by
# opts.get_field.
# Skip ordering on pk. This is always a valid order_by field
# but is an alias and therefore won't be found by opts.get_field.
if field_name == 'pk':
continue
try:
Expand Down
24 changes: 12 additions & 12 deletions django/middleware/csrf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,23 +110,23 @@ def process_view(self, request, callback, callback_args, callback_kwargs):
# Mechanism to turn off CSRF checks for test suite.
# It comes after the creation of CSRF cookies, so that
# everything else continues to work exactly the same
# (e.g. cookies are sent etc), but before the any
# branches that call reject()
# (e.g. cookies are sent, etc.), but before any
# branches that call reject().
return self._accept(request)

if request.is_secure():
# Suppose user visits http://example.com/
# An active network attacker,(man-in-the-middle, MITM) sends a
# POST form which targets https://example.com/detonate-bomb/ and
# submits it via javascript.
# An active network attacker (man-in-the-middle, MITM) sends a
# POST form that targets https://example.com/detonate-bomb/ and
# submits it via JavaScript.
#
# The attacker will need to provide a CSRF cookie and token, but
# that is no problem for a MITM and the session independent
# nonce we are using. So the MITM can circumvent the CSRF
# that's no problem for a MITM and the session-independent
# nonce we're using. So the MITM can circumvent the CSRF
# protection. This is true for any HTTP connection, but anyone
# using HTTPS expects better! For this reason, for
# using HTTPS expects better! For this reason, for
# https://example.com/ we need additional protection that treats
# http://example.com/ as completely untrusted. Under HTTPS,
# http://example.com/ as completely untrusted. Under HTTPS,
# Barth et al. found that the Referer header is missing for
# same-domain requests in only about 0.2% of cases or less, so
# we can use strict Referer checking.
Expand All @@ -141,7 +141,7 @@ def process_view(self, request, callback, callback_args, callback_kwargs):
)
return self._reject(request, REASON_NO_REFERER)

# Note that request.get_host() includes the port
# Note that request.get_host() includes the port.
good_referer = 'https://%s/' % request.get_host()
if not same_origin(referer, good_referer):
reason = REASON_BAD_REFERER % (referer, good_referer)
Expand All @@ -166,14 +166,14 @@ def process_view(self, request, callback, callback_args, callback_kwargs):
)
return self._reject(request, REASON_NO_CSRF_COOKIE)

# check non-cookie token for match
# Check non-cookie token for match.
request_csrf_token = ""
if request.method == "POST":
request_csrf_token = request.POST.get('csrfmiddlewaretoken', '')

if request_csrf_token == "":
# Fall back to X-CSRFToken, to make things easier for AJAX,
# and possible for PUT/DELETE
# and possible for PUT/DELETE.
request_csrf_token = request.META.get('HTTP_X_CSRFTOKEN', '')

if not constant_time_compare(request_csrf_token, csrf_token):
Expand Down
5 changes: 2 additions & 3 deletions docs/howto/custom-management-commands.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ command for the ``polls`` application from the
:doc:`tutorial</intro/tutorial01>`.

To do this, just add a ``management/commands`` directory to the application.
Each Python module in that directory will be auto-discovered. Modules having
names not starting with an underscore will be registered as commands that can be
executed as an action when you run ``manage.py``::
Django will register a ``manage.py`` command for each Python module in that
directory whose name doesn't begin with an underscore. For example::

polls/
__init__.py
Expand Down
4 changes: 2 additions & 2 deletions docs/ref/contrib/admin/index.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -697,8 +697,8 @@ subclass::

.. note::

The ``FieldListFilter`` API is currently considered internal and prone
to refactoring.
The ``FieldListFilter`` API is considered internal and might be
changed.

.. versionadded:: 1.4

Expand Down
89 changes: 40 additions & 49 deletions docs/ref/contrib/gis/install.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Because GeoDjango is included with Django, please refer to Django's

.. _spatial_database:

Spatial Database
Spatial database
----------------
PostgreSQL (with PostGIS), MySQL, Oracle, and SQLite (with SpatiaLite) are
the spatial databases currently supported.
Expand All @@ -69,7 +69,7 @@ SQLite GEOS, GDAL, PROJ.4, SpatiaLite 3.6.+ Requires

.. _geospatial_libs:

Geospatial Libraries
Geospatial libraries
--------------------
GeoDjango uses and/or provides interfaces for the following open source
geospatial libraries:
Expand Down Expand Up @@ -104,7 +104,7 @@ __ http://www.gaia-gis.it/spatialite/index.html

.. _build_from_source:

Building from Source
Building from source
====================

When installing from source on UNIX and GNU/Linux systems, please follow
Expand Down Expand Up @@ -156,7 +156,7 @@ script, compile, and install::
Troubleshooting
^^^^^^^^^^^^^^^

Can't find GEOS Library
Can't find GEOS library
~~~~~~~~~~~~~~~~~~~~~~~

When GeoDjango can't find GEOS, this error is raised:
Expand Down Expand Up @@ -297,7 +297,7 @@ __ http://trac.osgeo.org/gdal/wiki/GdalOgrInPython
Troubleshooting
^^^^^^^^^^^^^^^

Can't find GDAL Library
Can't find GDAL library
~~~~~~~~~~~~~~~~~~~~~~~

When GeoDjango can't find the GDAL library, the ``HAS_GDAL`` flag
Expand Down Expand Up @@ -410,7 +410,7 @@ __ http://www.sqlite.org/download.html

.. _spatialitebuild :

SpatiaLite Library (``libspatialite``) and Tools (``spatialite``)
SpatiaLite library (``libspatialite``) and tools (``spatialite``)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

After SQLite has been built with the R*Tree module enabled, get the latest
Expand Down Expand Up @@ -495,12 +495,12 @@ to build and install::

$ sudo python setup.py install

Post-Installation
Post-installation
=================

.. _spatialdb_template:

Creating a Spatial Database Template for PostGIS
Creating a spatial database template for PostGIS
------------------------------------------------

Creating a spatial database with PostGIS is different than normal because
Expand Down Expand Up @@ -549,7 +549,7 @@ These commands may be placed in a shell script for later use; for convenience
the following scripts are available:

=============== =============================================
PostGIS Version Bash Shell Script
PostGIS version Bash shell script
=============== =============================================
1.3 :download:`create_template_postgis-1.3.sh`
1.4 :download:`create_template_postgis-1.4.sh`
Expand All @@ -572,44 +572,34 @@ Afterwards, you may create a spatial database by simply specifying

.. _create_spatialite_db:

Creating a Spatial Database for SpatiaLite
-------------------------------------------
Creating a spatial database for SpatiaLite
------------------------------------------

After the SpatiaLite library and tools have been installed, it is now possible
to create a spatial database for use with GeoDjango.
After you've installed SpatiaLite, you'll need to create a number of spatial
metadata tables in your database in order to perform spatial queries.

For this, a number of spatial metadata tables must be created in the database
before any spatial query is performed against it.

If you are using SpatiaLite 3.0 or newer then use the ``spatialite`` utility to
call the ``InitSpatiaMetaData()`` function which will take care of that (you can
safely ignore the error messages shown) then you can skip the rest of this
section::
If you're using SpatiaLite 3.0 or newer, use the ``spatialite`` utility to
call the ``InitSpatiaMetaData()`` function, like this::

$ spatialite geodjango.db "SELECT InitSpatialMetaData();"
the SPATIAL_REF_SYS table already contains some row(s)
InitSpatiaMetaData ()error:"table spatial_ref_sys already exists"
0

If you re using a version of Spatialite older than 3.0 then to achieve the same
result you need to download a database initialization file and execute the SQL
queries it contains against your database.
You can safely ignore the error messages shown. When you've done this, you can
skip the rest of this section.

If you're using a version of SpatiaLite older than 3.0, you'll need to download
a database-initialization file and execute its SQL queries in your database.

First, get it from the appropiate SpatiaLite Resources page (i.e.
First, get it from the appropriate SpatiaLite Resources page (
http://www.gaia-gis.it/spatialite-2.3.1/resources.html for 2.3 or
http://www.gaia-gis.it/spatialite-2.4.0/ for 2.4)::

$ wget http://www.gaia-gis.it/spatialite-2.3.1/init_spatialite-2.3.sql.gz
$ gunzip init_spatialite-2.3.sql.gz

(Or, if you are using SpatiaLite 2.4 then do::

$ wget http://www.gaia-gis.it/spatialite-2.4.0/init_spatialite-2.4.sql.gz
$ gunzip init_spatialite-2.4.sql.gz

)

Now, the ``spatialite`` command can be used to initialize a spatial database::
Then, use the ``spatialite`` command to initialize a spatial database::

$ spatialite geodjango.db < init_spatialite-2.X.sql

Expand All @@ -629,15 +619,15 @@ features such as the geographic admin or KML sitemaps will not function properly

.. _addgoogleprojection:

Add Google Projection to ``spatial_ref_sys`` table
Add Google projection to ``spatial_ref_sys`` table
--------------------------------------------------

.. versionchanged:: 1.2

.. note::

If running PostGIS 1.4 and above, the entry is already included in the
default ``spatial_ref_sys`` table. You can skip this step.
If you're running PostGIS 1.4 or above, you can skip this step. The entry
is already included in the default ``spatial_ref_sys`` table.

In order to conduct database transformations to the so-called "Google"
projection (a spherical mercator projection used by Google Maps),
Expand Down Expand Up @@ -678,7 +668,7 @@ __ http://code.djangoproject.com/simpleticket

.. _libsettings:

Library Environment Settings
Library environment settings
----------------------------

By far, the most common problem when installing GeoDjango is that the
Expand All @@ -701,7 +691,7 @@ could place the following in their bash profile::

export LD_LIBRARY_PATH=/usr/local/lib

Setting System Library Path
Setting system library path
^^^^^^^^^^^^^^^^^^^^^^^^^^^

On GNU/Linux systems, there is typically a file in ``/etc/ld.so.conf``, which may include
Expand Down Expand Up @@ -740,7 +730,7 @@ Similarly, on Red Hat and CentOS systems::

$ sudo yum install binutils

Platform Specific Instructions
Platform-specific instructions
==============================

.. _macosx:
Expand All @@ -749,7 +739,7 @@ Mac OS X
--------

Because of the variety of packaging systems available for OS X, users have
several different options for installing GeoDjango. These options are:
several different options for installing GeoDjango. These options are:

* :ref:`kyngchaos`
* :ref:`fink`
Expand Down Expand Up @@ -789,7 +779,7 @@ __ http://python.org/ftp/python/2.6.2/python-2.6.2-macosx2009-04-16.dmg

.. _kyngchaos:

KyngChaos Packages
KyngChaos packages
^^^^^^^^^^^^^^^^^^

William Kyngesburye provides a number of `geospatial library binary packages`__
Expand Down Expand Up @@ -952,9 +942,9 @@ Ubuntu & Debian GNU/Linux
.. note::

The PostGIS SQL files are not placed in the PostgreSQL share directory in
the Debian and Ubuntu packages, and are located instead in a special
directory depending on the release. Thus, when :ref:`spatialdb_template`
use the :download:`create_template_postgis-debian.sh` script instead.
the Debian and Ubuntu packages. Instead, they're located in a special
directory depending on the release. In this case, use the
:download:`create_template_postgis-debian.sh` script

.. _ubuntu:

Expand Down Expand Up @@ -1049,10 +1039,11 @@ Debian

4.0 (Etch)
^^^^^^^^^^

The situation here is the same as that of Ubuntu :ref:`heron` -- in other words,
some packages must be built from source to work properly with GeoDjango.

Binary Packages
Binary packages
~~~~~~~~~~~~~~~
The following command will install acceptable binary packages, as well as
the development tools necessary to build the rest of the requirements::
Expand All @@ -1075,7 +1066,7 @@ Optional packages:

* ``libgeoip``: for :ref:`GeoIP <ref-geoip>` support

Source Packages
Source packages
~~~~~~~~~~~~~~~
You will still have to install :ref:`geosbuild`, :ref:`proj4`,
:ref:`postgis`, and :ref:`gdalbuild` from source. Please follow the
Expand Down Expand Up @@ -1104,7 +1095,7 @@ in the above command with the appropriate PostgreSQL version.

.. _post_install:

Post-installation Notes
Post-installation notes
~~~~~~~~~~~~~~~~~~~~~~~

If the PostgreSQL database cluster was not initiated after installing, then it
Expand Down Expand Up @@ -1234,7 +1225,7 @@ installer.

.. _OSGeo4W installer: http://trac.osgeo.org/osgeo4w/

Modify Windows Environment
Modify Windows environment
^^^^^^^^^^^^^^^^^^^^^^^^^^

In order to use GeoDjango, you will need to add your Python and OSGeo4W
Expand Down Expand Up @@ -1269,8 +1260,8 @@ script, :download:`geodjango_setup.bat`.
then you will need to modify the ``OSGEO4W_ROOT`` and/or ``PYTHON_ROOT``
variables accordingly.

Install Django and Setup Database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Install Django and set up database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Finally, :ref:`install Django <installing-official-release>` on your system.
You do not need to create a spatial database template, as one named
Expand Down
Loading

0 comments on commit 7981efe

Please sign in to comment.