This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository x2gobroker. commit 3793b3329075ac743e2cd6d2a81c7092e8d0262d Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Fri Sep 14 11:26:49 2018 +0200 x2gobroker/loggers.py: Add/improve API documentation. --- x2gobroker/loggers.py | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/x2gobroker/loggers.py b/x2gobroker/loggers.py index 1baca90..fa06bf0 100644 --- a/x2gobroker/loggers.py +++ b/x2gobroker/loggers.py @@ -17,6 +17,19 @@ # Free Software Foundation, Inc., # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. +"""\ +The :mod:`x2gobroker.loggers` module provides three different logger objects for different purposes: + + * ``logger_broker``: Logging of all sort of things happening in X2Go Session Broker + * ``logger_access``: Logging of http/https access of the broker's httpd daemon + * ``logger_error``: Logging of errors encountered at runtime + +All ``logger_*`` objects are instantiated via the function :func:`logging.getLogger()` from the :mod:`logging` module.. + +Depending on the execution context (as a service, in foreground for debugging, as SSH broker), these logging objects are set up slighly different. + +""" + import os import sys import pwd @@ -103,8 +116,8 @@ else: def tornado_log_request(handler): """\ - Function for overriding the log_request method in - ``tornado.web.RequestHandler``. + Function for overriding the :func:`log_request() <tornado.web.RequestHandler>` method in + :class:`tornado.web.RequestHandler`. :param handler: handler :type handler: ``obj`` -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git