From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Tue, 19 Apr 2011 12:47:23 +0000 (+0100)
Subject: Updated documentation on fileConfig().
X-Git-Tag: v2.7.2rc1~138
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0513275b58e1a99b028f7e2317e5faa4984fde0d;p=python

Updated documentation on fileConfig().
---

diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 2412dde227..500c736be3 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -74,15 +74,29 @@ in :mod:`logging` itself) and defining handlers which are declared either in
 
    .. versionadded:: 2.7
 
-.. function:: fileConfig(fname[, defaults])
+.. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True)
 
-   Reads the logging configuration from a :mod:`configparser`\-format file named
-   *fname*. This function can be called several times from an application,
-   allowing an end user to select from various pre-canned
+   Reads the logging configuration from a :mod:`configparser`\-format file
+   named *fname*. This function can be called several times from an
+   application, allowing an end user to select from various pre-canned
    configurations (if the developer provides a mechanism to present the choices
-   and load the chosen configuration). Defaults to be passed to the ConfigParser
-   can be specified in the *defaults* argument.
-
+   and load the chosen configuration).
+
+   :param defaults: Defaults to be passed to the ConfigParser can be specified
+                    in this argument.
+
+   :param disable_existing_loggers: If specified as ``False``, loggers which
+                                    exist when this call is made are left
+                                    alone. The default is ``True`` because this
+                                    enables old behaviour in a backward-
+                                    compatible way. This behaviour is to
+                                    disable any existing loggers unless they or
+                                    their ancestors are explicitly named in the
+                                    logging configuration.
+
+   .. versionchanged:: 2.6
+      The ``disable_existing_loggers`` keyword argument was added. Previously,
+      existing loggers were *always* disabled.
 
 .. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT)