From 427a8b4485b689dbd71be9bb994b787f859112d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Massart?= <fmcell@gmail.com>
Date: Tue, 21 Nov 2017 18:21:31 +0800
Subject: [PATCH] [2.0.x] Clarified who the AdminEmailHandler emails.
Backport of a5f1e5809f26d93ea0c6010bb44895b3d1992089 from master
---
docs/ref/settings.txt | 11 +++++------
docs/topics/logging.txt | 14 +++++++-------
2 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index 4ac811797e..a357134b27 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -48,15 +48,14 @@ of the case of the actual model class name.
Default: ``[]`` (Empty list)
A list of all the people who get code error notifications. When
-``DEBUG=False`` and a view raises an exception, Django will email these people
-with the full exception information. Each item in the list should be a tuple
-of (Full name, email address). Example::
+:setting:`DEBUG=False <DEBUG>` and :class:`~django.utils.log.AdminEmailHandler`
+is configured in :setting:`LOGGING` (done by default), Django emails these
+people the details of exceptions raised in the request/response cycle.
+
+Each item in the list should be a tuple of (Full name, email address). Example::
[('John', 'john@example.com'), ('Mary', 'mary@example.com')]
-Note that Django will email *all* of these people whenever an error happens.
-See :doc:`/howto/error-reporting` for more information.
-
.. setting:: ALLOWED_HOSTS
``ALLOWED_HOSTS``
diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt
index 800be95885..26054cd2f9 100644
--- a/docs/topics/logging.txt
+++ b/docs/topics/logging.txt
@@ -377,13 +377,13 @@ This logging configuration does the following things:
* Defines two handlers:
- * ``console``, a StreamHandler, which will print any ``INFO``
- (or higher) message to stderr. This handler uses the ``simple`` output
- format.
+ * ``console``, a :class:`~logging.StreamHandler`, which prints any ``INFO``
+ (or higher) message to ``sys.stderr``. This handler uses the ``simple``
+ output format.
- * ``mail_admins``, an AdminEmailHandler, which will email any
- ``ERROR`` (or higher) message to the site admins. This handler uses
- the ``special`` filter.
+ * ``mail_admins``, an :class:`AdminEmailHandler`, which emails any ``ERROR``
+ (or higher) message to the site :setting:`ADMINS`. This handler uses the
+ ``special`` filter.
* Configures three loggers:
@@ -590,7 +590,7 @@ Python logging module.
.. class:: AdminEmailHandler(include_html=False, email_backend=None)
- This handler sends an email to the site admins for each log
+ This handler sends an email to the site :setting:`ADMINS` for each log
message it receives.
If the log record contains a ``request`` attribute, the full details