From c60b1bc86196a12db0edead31ef4d48a901aad96 Mon Sep 17 00:00:00 2001 From: Pedro Algarvio Date: Thu, 12 Sep 2013 12:48:19 +0100 Subject: [PATCH] Added `versionadded` where appropriate. --- salt/log/handlers/__init__.py | 4 ++++ salt/log/handlers/logstash_mod.py | 2 ++ salt/log/handlers/sentry_mod.py | 2 ++ salt/log/mixins.py | 2 ++ salt/log/setup.py | 2 +- 5 files changed, 11 insertions(+), 1 deletion(-) diff --git a/salt/log/handlers/__init__.py b/salt/log/handlers/__init__.py index 532b850bf1..eddee622ce 100644 --- a/salt/log/handlers/__init__.py +++ b/salt/log/handlers/__init__.py @@ -3,6 +3,8 @@ salt.log.handlers ~~~~~~~~~~~~~~~~~ + .. versionadded:: 0.17.0 + Custom logging handlers to be used in salt. :codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)` @@ -54,6 +56,8 @@ class TemporaryLoggingHandler(logging.NullHandler): initial log messages to the function :func:`TemporaryLoggingHandler.sync_with_handlers` and all stored log records will be dispatched to the provided handlers. + + .. versionadded:: 0.17.0 ''' def __init__(self, level=logging.NOTSET, max_queue_size=10000): diff --git a/salt/log/handlers/logstash_mod.py b/salt/log/handlers/logstash_mod.py index 645e00100b..a84d43ddf6 100644 --- a/salt/log/handlers/logstash_mod.py +++ b/salt/log/handlers/logstash_mod.py @@ -3,6 +3,8 @@ Logstash Logging Handler ======================== + .. versionadded:: 0.17.0 + This module provides some `Logstash`_ logging handlers. diff --git a/salt/log/handlers/sentry_mod.py b/salt/log/handlers/sentry_mod.py index 5db88be3aa..0e3bbc3cd2 100644 --- a/salt/log/handlers/sentry_mod.py +++ b/salt/log/handlers/sentry_mod.py @@ -3,6 +3,8 @@ Sentry Logging Handler ====================== + .. versionadded:: 0.17.0 + Configuring the python `Sentry`_ client, `Raven`_, should be done under the ``sentry_handler`` configuration key. At the bare minimum, you need to define the `DSN`_. As an example: diff --git a/salt/log/mixins.py b/salt/log/mixins.py index 7bd5511d34..d090ffeb0d 100644 --- a/salt/log/mixins.py +++ b/salt/log/mixins.py @@ -3,6 +3,8 @@ salt.log.mixins ~~~~~~~~~~~~~~~ + .. versionadded:: 0.17.0 + Some mix-in classes to be used in salt's logging :codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)` diff --git a/salt/log/setup.py b/salt/log/setup.py index c55100a275..1d4504a093 100644 --- a/salt/log/setup.py +++ b/salt/log/setup.py @@ -7,7 +7,7 @@ This module should be imported as soon as possible, preferably the first module salt or any salt depending library imports so any new logging - logger instance uses our ``salt.log.SaltLoggingClass``. + logger instance uses our ``salt.log.setup.SaltLoggingClass``. :copyright: 2011-2012 :email:`Pedro Algarvio (pedro@algarvio.me)`