From 96f06e8171a4145feca8c750011cdd1d84a7b948 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Mon, 3 May 2010 18:22:08 -0700
Subject: doc: misc updates

* avoid needless links to /Rainbows.html
* keepalive_timeout has been 5 seconds by default for a while
* update "Gemcutter" references to "RubyGems.org"
---
 GNUmakefile     | 2 +-
 README          | 6 +++---
 lib/rainbows.rb | 6 +++++-
 3 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/GNUmakefile b/GNUmakefile
index 051c4fe..7d37f69 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -167,7 +167,7 @@ release: verify package $(release_notes) $(release_changes)
 	# make tgz release on RubyForge
 	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
 	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
-	# push gem to Gemcutter
+	# push gem to RubyGems.org
 	gem push $(pkggem)
 	# in case of gem downloads from RubyForge releases page
 	-rubyforge add_file \
diff --git a/README b/README
index 21f07d4..b0ac444 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
-= Rainbows! Unicorn for sleepy apps and slow clients
+= Rainbows! - Unicorn for sleepy apps and slow clients
 
-Rainbows! is an HTTP server for sleepy Rack applications.  It is based on
+\Rainbows! is an HTTP server for sleepy Rack applications.  It is based on
 Unicorn, but designed to handle applications that expect long
 request/response times and/or slow clients.  For Rack applications not
 heavily bound by slow external network dependencies, consider Unicorn
@@ -92,7 +92,7 @@ and run setup.rb after unpacking it:
 
 http://rubyforge.org/frs/?group_id=8977
 
-You may also install it via RubyGems on Gemcutter:
+You may also install it via RubyGems on RubyGems.org:
 
   gem install rainbows
 
diff --git a/lib/rainbows.rb b/lib/rainbows.rb
index 3d1dc20..30b5fd5 100644
--- a/lib/rainbows.rb
+++ b/lib/rainbows.rb
@@ -22,8 +22,10 @@ module Rainbows
       false
     end
   end
+  # :stopdoc:
   G = State.new(true, 0, 0, 5)
   O = {}
+  # :startdoc:
 
   require 'rainbows/const'
   require 'rainbows/http_server'
@@ -111,7 +113,7 @@ module Rainbows
   # +worker_processes+ * +worker_connections+, so in the above example
   # we can serve 8 * 400 = 3200 clients concurrently.
   #
-  # The default is +keepalive_timeout+ is 2 seconds, which should be
+  # The default is +keepalive_timeout+ is 5 seconds, which should be
   # enough under most conditions for browsers to render the page and
   # start retrieving extra elements for.  Increasing this beyond 5
   # seconds is not recommended.  Zero disables keepalive entirely
@@ -125,6 +127,7 @@ module Rainbows
     HttpServer.setup(block)
   end
 
+  # :stopdoc:
   # maps models to default worker counts, default worker count numbers are
   # pretty arbitrary and tuning them to your application and hardware is
   # highly recommended
@@ -147,6 +150,7 @@ module Rainbows
     u = model.to_s.gsub(/([a-z0-9])([A-Z0-9])/) { "#{$1}_#{$2.downcase!}" }
     autoload model, "rainbows/#{u.downcase!}"
   end
+  # :startdoc:
   autoload :Fiber, 'rainbows/fiber' # core class
 
 end
-- 
cgit v1.2.3-24-ge0c7