aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorNate Smith <nwjsmith@gmail.com>2015-12-23 10:06:10 -0500
committerNate Smith <nwjsmith@gmail.com>2015-12-23 12:40:58 -0500
commit5f73c3cd51eb367b07c1a150092e6f8df3bdd759 (patch)
treea568c07ad595a15605954d6446287b3ad214c518 /activesupport
parente426258aa263d2646aad27e498f550ac49a8d388 (diff)
downloadrails-5f73c3cd51eb367b07c1a150092e6f8df3bdd759.tar.gz
rails-5f73c3cd51eb367b07c1a150092e6f8df3bdd759.tar.bz2
rails-5f73c3cd51eb367b07c1a150092e6f8df3bdd759.zip
Document `Logger#broadcast_messages` option
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/logger.rb10
1 files changed, 9 insertions, 1 deletions
diff --git a/activesupport/lib/active_support/logger.rb b/activesupport/lib/active_support/logger.rb
index 82117a64d2..6f2ab310b9 100644
--- a/activesupport/lib/active_support/logger.rb
+++ b/activesupport/lib/active_support/logger.rb
@@ -5,7 +5,15 @@ module ActiveSupport
class Logger < ::Logger
include LoggerSilence
- attr_accessor :broadcast_messages
+ # If +true+, will broadcast all messages sent to this logger to the any
+ # logger linked to this one via +broadcast+.
+ #
+ # If +false+, the logger will still forward calls to +close+, +progname=+,
+ # +formatter=+ and +level+ to any linked loggers, but no calls to +add+ or
+ # +<<+.
+ #
+ # Defaults to +true+.
+ attr_accessor :broadcast_messages # :nodoc:
# Broadcasts logs to multiple loggers.
def self.broadcast(logger) # :nodoc: