From bc17531c1eb67f2a5eb31b966f2ede63d767b803 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sat, 24 Nov 2018 00:59:35 -0600 Subject: Split long complicated sentence into 3 --- docs/narr/logging.rst | 9 ++++----- docs/narr/startup.rst | 2 ++ 2 files changed, 6 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/narr/logging.rst b/docs/narr/logging.rst index 408c8fc7c..b12434317 100644 --- a/docs/narr/logging.rst +++ b/docs/narr/logging.rst @@ -40,11 +40,10 @@ format `. This is the same format used as the Python The application-related and logging-related sections in the configuration file can coexist peacefully. The logging-related sections in the file configure logging when you run ``pserve``. -The ``pserve`` command calls the :func:`pyramid.paster.setup_logging` function, -a thin wrapper around the :func:`logging.config.fileConfig` using the specified -``.ini`` file, if it contains a ``[loggers]`` section (all of the -cookiecutter-generated ``.ini`` files do). -``setup_logging`` reads the logging configuration from the ``ini`` file given on the ``pserve`` command line. +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. 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 diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 29e5436fe..ff94f441e 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -68,6 +68,8 @@ Here's a high-level time-ordered overview of what happens when you press will have a single ``[app:main]`` section in it, and this will be the application served. +.. _startup_logging_initialization: + #. The framework finds all :mod:`logging` related configuration in the ``.ini`` file and uses it to configure the Python standard library logging system for the application. See :ref:`logging_config` for more information. -- cgit v1.2.3