about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-06-06 06:47:02 +0000
committerEric Wong <normalperson@yhbt.net>2010-06-06 06:47:02 +0000
commite3dfea56ec8f189711f7904a9a05dbbfc0bd6acc (patch)
treec2422df07208cb4176b3ab80fe5095a9f86d2eed
parentb895d3d0393a647d3602783bc53bf68e223e51c9 (diff)
-rw-r--r--.document1
-rw-r--r--GNUmakefile2
-rw-r--r--LICENSE15
-rw-r--r--README27
-rw-r--r--lib/clogger.rb5
5 files changed, 27 insertions, 23 deletions
diff --git a/.document b/.document
index 243e30e..cd05772 100644
--- a/.document
+++ b/.document
@@ -3,3 +3,4 @@ NEWS
 ChangeLog
 lib
 ext/clogger_ext/clogger.c
+LICENSE
diff --git a/GNUmakefile b/GNUmakefile
index 549de27..4addaf2 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -73,7 +73,7 @@ atom = <link rel="alternate" title="Atom feed" href="$(1)" \
              type="application/atom+xml"/>
 
 doc: .document NEWS ChangeLog
-        rdoc -Na -t "$(shell sed -ne '1s/^= //p' README)"
+        rdoc -a -t "$(shell sed -ne '1s/^= //p' README)"
         install -m644 COPYING doc/COPYING
         install -m644 $(shell grep '^[A-Z]' .document)  doc/
         $(RUBY) -i -p -e \
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fe7e4d3
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,15 @@
+\Clogger is copyrighted Free Software by all contributors, see logs in
+revision control for names and email addresses of all of them.
+
+You can redistribute it and/or modify it under the terms of the GNU Lesser
+General Public License as published by the Free Software Foundation, version 3
+{LGPLv3}[http://www.gnu.org/licenses/lgpl-3.txt] (see link:COPYING).
+
+\Clogger is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
diff --git a/README b/README
index 3c6cf34..0d15292 100644
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
-= Clogger - configurable request logging for Rack
+= \Clogger - configurable request logging for Rack
 
 == DESCRIPTION
 
-Clogger is Rack middleware for logging HTTP requests.  The log format
+\Clogger is Rack middleware for logging HTTP requests.  The log format
 is customizable so you can specify exactly which fields to log.
 
 == FEATURES
@@ -21,12 +21,12 @@ is customizable so you can specify exactly which fields to log.
     all bytes in the range of \x00-\x1F
 
 * multi-instance capable and (optionally) reentrant.  You can use
-  Clogger in a multi-threaded server, and even multiple Cloggers logging
+  \Clogger in a multi-threaded server, and even multiple Cloggers logging
   to different locations and different formats in the same process.
 
 == SYNOPSIS
 
-Clogger may be loaded as Rack middleware in your config.ru:
+\Clogger may be loaded as Rack middleware in your config.ru:
 
   require "clogger"
   use Clogger,
@@ -81,7 +81,7 @@ somewhere inside the "Rails::Initializer.run do |config|" block:
 
 == REQUIREMENTS
 
-* Ruby, Rack
+* {Ruby}[http://ruby-lang.org/], {Rack}[http://rack.rubyforge.org/]
 
 == DEVELOPMENT
 
@@ -126,20 +126,3 @@ There is an optional C extension that should be compatible with MRI
 other Ruby implementations, but be sure to let us know if that's not the
 case.  No pre-built binaries are currently distributed, let us know if
 you're interested in helping with the release/support effort.
-
-== LICENSE
-
-Copyright (C) 2009 Eric Wong and contributors.
-
-Clogger is free software; you can redistribute it and/or modify it under
-the terms of the GNU Lesser General Public License as published by the
-Free Software Foundation, version 3.0.
-
-Clogger is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
-License in the COPYING file for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with Clogger; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
diff --git a/lib/clogger.rb b/lib/clogger.rb
index a827632..8339f59 100644
--- a/lib/clogger.rb
+++ b/lib/clogger.rb
@@ -1,9 +1,13 @@
 # -*- encoding: binary -*-
 autoload :Rack, 'rack'
 
+# See the README for usage instructions
 class Clogger
+
+  # the version of Clogger, currently 0.4.0
   VERSION = '0.4.0'
 
+  # :stopdoc:
   OP_LITERAL = 0
   OP_REQUEST = 1
   OP_RESPONSE = 2
@@ -141,6 +145,7 @@ private
     end
   end
 
+  # :startdoc:
 end
 
 require 'clogger/format'