summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJustin Bronn <jbronn@gmail.com>2011-09-10 18:04:27 +0000
committerJustin Bronn <jbronn@gmail.com>2011-09-10 18:04:27 +0000
commit05e29716b446f71eef8318f8093f0c19726ae22f (patch)
treec2c83e13e4900b718f40d6fa3230843807ce3c70 /docs
parentefb832744466548ea6f86fa027ffe702baa0d9a0 (diff)
Fixed #16553 -- Refactored the `GeoIP` module, moving it `django.contrib.gis.geoip`; fixed memory leaks, and encoding issues.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16783 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/deprecation.txt4
-rw-r--r--docs/ref/contrib/gis/geoip.txt17
-rw-r--r--docs/ref/contrib/gis/index.txt1
-rw-r--r--docs/ref/contrib/gis/utils.txt15
4 files changed, 17 insertions, 20 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt
index 14004b034a..88354e1b41 100644
--- a/docs/internals/deprecation.txt
+++ b/docs/internals/deprecation.txt
@@ -239,6 +239,10 @@ their deprecation, as per the :ref:`deprecation policy
were deprecated since Django 1.4 and will be removed in favor
of the ``django.utils.text.Truncator`` class.
+ * The :class:`~django.contrib.gis.geoip.GeoIP` class was moved to
+ :mod:`django.contrib.gis.geoip` in 1.4 -- the shortcut in
+ :mod:`django.contrib.gis.utils` will be removed.
+
2.0
---
diff --git a/docs/ref/contrib/gis/geoip.txt b/docs/ref/contrib/gis/geoip.txt
index 6503be7c3f..62185834ca 100644
--- a/docs/ref/contrib/gis/geoip.txt
+++ b/docs/ref/contrib/gis/geoip.txt
@@ -4,10 +4,17 @@
Geolocation with GeoIP
======================
-.. module:: django.contrib.gis.utils.geoip
+.. module:: django.contrib.gis.geoip
:synopsis: High-level Python interface for MaxMind's GeoIP C library.
-.. currentmodule:: django.contrib.gis.utils
+.. versionchanged:: 1.4
+
+.. note::
+
+ In Django 1.4, the :class:`GeoIP` object was moved out of
+ :mod:`django.contrib.gis.utils` and into its own module,
+ :mod:`django.contrib.gis.geoip`. A shortcut is still provided
+ in ``utils``, but will be removed in Django 1.6.
The :class:`GeoIP` object is a ctypes wrapper for the
`MaxMind GeoIP C API`__. [#]_ This interface is a BSD-licensed alternative
@@ -136,7 +143,7 @@ Querying
All the following querying routines may take either a string IP address
or a fully qualified domain name (FQDN). For example, both
-``'24.124.1.80'`` and ``'djangoproject.com'`` would be valid query
+``'205.186.163.125'`` and ``'djangoproject.com'`` would be valid query
parameters.
.. method:: GeoIP.city(query)
@@ -144,7 +151,7 @@ parameters.
Returns a dictionary of city information for the given query. Some
of the values in the dictionary may be undefined (``None``).
-.. method:: GeoIPcountry(query)
+.. method:: GeoIP.country(query)
Returns a dictionary with the country code and country for the given
query.
@@ -190,7 +197,7 @@ This property returns information about the GeoIP city database.
.. attribute:: GeoIP.info
This property returns information about all GeoIP databases (both city
-and country).
+and country), and the version of the GeoIP C library (if supported).
GeoIP-Python API compatibility methods
----------------------------------------
diff --git a/docs/ref/contrib/gis/index.txt b/docs/ref/contrib/gis/index.txt
index 7a4b447453..1b1e7688d0 100644
--- a/docs/ref/contrib/gis/index.txt
+++ b/docs/ref/contrib/gis/index.txt
@@ -22,6 +22,7 @@ of spatially enabled data.
measure
geos
gdal
+ geoip
utils
commands
admin
diff --git a/docs/ref/contrib/gis/utils.txt b/docs/ref/contrib/gis/utils.txt
index 9f8e518d09..fee6325437 100644
--- a/docs/ref/contrib/gis/utils.txt
+++ b/docs/ref/contrib/gis/utils.txt
@@ -13,20 +13,5 @@ useful in creating geospatial Web applications.
.. toctree::
:maxdepth: 2
- geoip
layermapping
ogrinspect
-
-GeoIP
-=====
-
-Interface to the MaxMind GeoIP library for performing IP-based geolocation
-from GeoDjango. See :ref:`GeoIP reference <ref-geoip>` documentation for
-more information.
-
-LayerMapping
-============
-
-The :class:`~django.contrib.gis.utils.LayerMapping` simplifies the process
-of importing spatial data and attributes into your GeoDjango models.
-