summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorJeremy Evans <code@jeremyevans.net>2019-11-17 17:34:56 -0800
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2019-12-10 20:59:36 +0900
commit7a1c56f978907d03876772d942619ec90cbbfa6b (patch)
tree6d53b78805d9d892715099054d6f81e597240754 /lib
parent38722fa179fcec549300b2f35206f4eb168f202e (diff)
[ruby/logger] Document that shift_age of 0 disables log file rotation
Fixes Ruby Bug 16349. https://github.com/ruby/logger/commit/b1b6d06f2d
Diffstat (limited to 'lib')
-rw-r--r--lib/logger.rb7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/logger.rb b/lib/logger.rb
index bb4f1159a8..f0b99f75a2 100644
--- a/lib/logger.rb
+++ b/lib/logger.rb
@@ -353,10 +353,11 @@ class Logger
# +STDOUT+, +STDERR+, or an open file).
# +shift_age+::
# Number of old log files to keep, *or* frequency of rotation (+daily+,
- # +weekly+ or +monthly+). Default value is 0.
+ # +weekly+ or +monthly+). Default value is 0, which disables log file
+ # rotation.
# +shift_size+::
- # Maximum logfile size in bytes (only applies when +shift_age+ is a number).
- # Defaults to +1048576+ (1MB).
+ # Maximum logfile size in bytes (only applies when +shift_age+ is a positive
+ # Integer). Defaults to +1048576+ (1MB).
# +level+::
# Logging severity threshold. Default values is Logger::DEBUG.
# +progname+::