diff options
| author | Serdar Sutay <serdar@opscode.com> | 2014-05-21 16:27:32 -0700 |
|---|---|---|
| committer | Serdar Sutay <serdar@opscode.com> | 2014-05-21 16:27:32 -0700 |
| commit | 9dfcd70f8982b87b02628b2e28a18d586b34cd1d (patch) | |
| tree | 4d34e6fb6209672c409570c133e33de4a52b6c25 | |
| parent | 417baa62d0dc6379d7d7bb054731e3ca9cb226bd (diff) | |
| parent | 2a74447645a1b855758f896aa6fd8162368cece2 (diff) | |
| download | mixlib-log-9dfcd70f8982b87b02628b2e28a18d586b34cd1d.tar.gz | |
Merge pull request #4 from ampledata/patch-1
Fixing RDoc formatting of README.rdoc.
| -rw-r--r-- | README.rdoc | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/README.rdoc b/README.rdoc index 1fc8ba1..faf9427 100644 --- a/README.rdoc +++ b/README.rdoc @@ -2,23 +2,23 @@ Mixlib::Log provides a mixin for enabling a class based logger object, a-la Merb, Chef, and Nanite. To use it: - require 'mixlib/log' - - class Log - extend Mixlib::Log - end - + require 'mixlib/log' + + class Log + extend Mixlib::Log + end + You can then do: - Log.debug("foo") - Log.info("bar") - Log.warn("baz") - Log.error("baz") - Log.fatal("wewt") - -By default, Mixlib::Logger logs to STDOUT. To alter this, you should call Log.init, passing any arguments to the standard Ruby Logger. For example: + Log.debug('foo') + Log.info('bar') + Log.warn('baz') + Log.error('baz') + Log.fatal('wewt') + +By default, <tt>Mixlib::Logger</tt> logs to STDOUT. To alter this, you should call +Log.init+, passing any arguments to the standard Ruby Logger. For example: + + Log.init('/tmp/logfile') # log to /tmp/logfile + Log.init('/tmp/logfile', 7) # log to /tmp/logfile, rotate every day - Log.init("/tmp/logfile") # log to /tmp/logfile - Log.init("/tmp/logfile", 7) # log to /tmp/logfile, rotate every day - -Enjoy! +Enjoy!
\ No newline at end of file |