From 6ca75ed314188de40a8676bf1258762bc9522b91 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sat, 24 Nov 2018 08:10:47 -0600 Subject: Use numbered list instead of a paragraph per Steve Piercy --- docs/narr/logging.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/narr/logging.rst b/docs/narr/logging.rst index 8ae8469de..58bd2d4ec 100644 --- a/docs/narr/logging.rst +++ b/docs/narr/logging.rst @@ -43,10 +43,14 @@ The logging-related sections in the file configure logging when you run ``pserve .. index:: pair: logging; startup -On :ref:`startup ` the ``pserve`` command :ref:`configures logging ` using the ``.ini`` file given to it. -If the ``.ini`` file contains a ``[loggers]`` section (all of the cookiecutter-generated ``.ini`` files do) ``pserve`` calls the :func:`pyramid.paster.setup_logging` function. -The :func:`setup_logging` function is a thin wrapper around the :func:`logging.config.fileConfig`. -When ``setup_logging`` is passed the ``ini`` file given on the ``pserve`` command line it reads the file and configures logging. +If the configuration ``.ini`` file, specified when invoking ``pserve``, contains a ``[loggers]`` section then on :ref:`startup ` the following process takes place: + +#. The ``pserve`` command calls the :func:`pyramid.paster.setup_logging` function, passing the ``.ini`` file. + +#. ``setup_logging`` is a thin wrapper which calls the Python standard library's :func:`logging.config.fileConfig`. + +#. :func:`logging.config.fileConfig` reads the logging configuration from the ``.ini`` file and configures logging. + Default logging configuration is provided in both the default ``development.ini`` and the ``production.ini`` files. If you use our cookiecutter to generate a Pyramid project with the name of the package as ``hello_world``, then the logging configuration -- cgit v1.2.3