[Python-checkins] cpython (merge 3.2 -> default): Merged documentation fix from 3.2.

vinay.sajip python-checkins at python.org
Tue Apr 19 14:59:04 CEST 2011


http://hg.python.org/cpython/rev/253f8623ea0b
changeset:   69440:253f8623ea0b
parent:      69437:8c49f7fbba1d
parent:      69439:d4bc42400692
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Tue Apr 19 13:58:49 2011 +0100
summary:
  Merged documentation fix from 3.2.

files:
  Doc/library/logging.config.rst |  23 ++++++++++++++++-----
  1 files changed, 17 insertions(+), 6 deletions(-)


diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -74,14 +74,25 @@
 
    .. versionadded:: 3.2
 
-.. 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.
 
 
 .. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT)

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list