summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Morozov <inductor2000@mail.ru>2015-11-11 11:26:07 +0300
committerTim Graham <timograham@gmail.com>2015-11-17 10:18:07 -0500
commitb4aa38d106e903a21773d3486885fd8d2fa8a660 (patch)
tree210b47dff02d7906edf58d17f8317adabf5a3a76
parent583d3c081a2869cfad78c4993988bcded3775524 (diff)
[1.8.x] Fixed #25710 -- Clarified the docs about what INTERNAL_IPS does.
Backport of 5abed864ee1cd31a0b920768b4abe85b26b43a4d from master
-rw-r--r--docs/ref/contrib/admin/admindocs.txt1
-rw-r--r--docs/ref/settings.txt9
-rw-r--r--docs/ref/templates/api.txt2
-rw-r--r--docs/topics/logging.txt4
4 files changed, 12 insertions, 4 deletions
diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt
index 6be06d4fc1..f129758243 100644
--- a/docs/ref/contrib/admin/admindocs.txt
+++ b/docs/ref/contrib/admin/admindocs.txt
@@ -137,6 +137,7 @@ Django's :ref:`template loaders <template-loaders>`. This can be a handy way to
check if the specified template exists and to show where on the filesystem that
template is stored.
+.. _admindocs-bookmarklets:
Included Bookmarklets
=====================
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 734218df86..426cae5404 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -1656,9 +1656,12 @@ Default: ``()`` (Empty tuple)
A tuple of IP addresses, as strings, that:
-* See debug comments, when :setting:`DEBUG` is ``True``
-* Receive X headers in admindocs if the ``XViewMiddleware`` is installed (see
- :doc:`/ref/contrib/admin/admindocs`)
+* Allow the :func:`~django.template.context_processors.debug` context processor
+ to add some variables to the template context.
+* Can use the :ref:`admindocs bookmarklets <admindocs-bookmarklets>` even if
+ not logged in as a staff user.
+* Are marked as "internal" (as opposed to "EXTERNAL") in
+ :class:`~django.utils.log.AdminEmailHandler` emails.
.. setting:: LANGUAGE_CODE
diff --git a/docs/ref/templates/api.txt b/docs/ref/templates/api.txt
index 5a2fa6a1ec..52721210e7 100644
--- a/docs/ref/templates/api.txt
+++ b/docs/ref/templates/api.txt
@@ -661,6 +661,8 @@ variables:
django.template.context_processors.debug
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. function:: debug
+
If this processor is enabled, every ``RequestContext`` will contain these two
variables -- but only if your :setting:`DEBUG` setting is set to ``True`` and
the request's IP address (``request.META['REMOTE_ADDR']``) is in the
diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt
index d88b1de064..67e1d104ad 100644
--- a/docs/topics/logging.txt
+++ b/docs/topics/logging.txt
@@ -555,7 +555,9 @@ Python logging module.
message it receives.
If the log record contains a ``request`` attribute, the full details
- of the request will be included in the email.
+ of the request will be included in the email. The email subject will be
+ include the phrase "internal IP" if the client's IP address is in the
+ :setting:`INTERNAL_IPS` setting; if not, it will include "EXTERNAL IP".
If the log record contains stack trace information, that stack
trace will be included in the email.