about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-09-28 00:13:12 -0700
committerEric Wong <normalperson@yhbt.net>2009-09-28 00:14:00 -0700
commit69b6f9aaec80f3da2f9d249545c06ccb6ec316cb (patch)
tree8bccee0c30dbd6df1647fe5e1027f4bdd74227a2
parent3c1449df986387f6d812a97adf5f8fa47c28c891 (diff)
downloadunicorn-69b6f9aaec80f3da2f9d249545c06ccb6ec316cb.tar.gz
Hopefuly make it more obvious that they're Ruby symbols and not
strings.  While we're at it, fix ordering of :{rcv,snd}buf
descriptions to (logically) match the order of mention.
-rw-r--r--lib/unicorn/configurator.rb12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/unicorn/configurator.rb b/lib/unicorn/configurator.rb
index 0351a60..f64753c 100644
--- a/lib/unicorn/configurator.rb
+++ b/lib/unicorn/configurator.rb
@@ -197,7 +197,7 @@ module Unicorn
     #
     # The following options may be specified (but are generally not needed):
     #
-    # +backlog+: this is the backlog of the listen() syscall.
+    # +:backlog+: this is the backlog of the listen() syscall.
     #
     # Some operating systems allow negative values here to specify the
     # maximum allowable value.  In most cases, this number is only
@@ -212,7 +212,7 @@ module Unicorn
     #
     # Default: 1024
     #
-    # +rcvbuf+, +sndbuf+: maximum send and receive buffer sizes of sockets
+    # +:rcvbuf+, +:sndbuf+: maximum receive and send buffer sizes of sockets
     #
     # These correspond to the SO_RCVBUF and SO_SNDBUF settings which
     # can be set via the setsockopt(2) syscall.  Some kernels
@@ -226,13 +226,13 @@ module Unicorn
     #
     # Defaults: operating system defaults
     #
-    # +tcp_nodelay+: disables Nagle's algorithm on TCP sockets
+    # +:tcp_nodelay+: disables Nagle's algorithm on TCP sockets
     #
     # This has no effect on UNIX sockets.
     #
     # Default: operating system defaults (usually Nagle's algorithm enabled)
     #
-    # +tcp_nopush+: enables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
+    # +:tcp_nopush+: enables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
     #
     # This will prevent partial TCP frames from being sent out.
     # Enabling +tcp_nopush+ is generally not needed or recommended as
@@ -242,7 +242,7 @@ module Unicorn
     #
     # This has no effect on UNIX sockets.
     #
-    # +tries+: times to retry binding a socket if it is already in use
+    # +:tries+: times to retry binding a socket if it is already in use
     #
     # A negative number indicates we will retry indefinitely, this is
     # useful for migrations and upgrades when individual workers
@@ -250,7 +250,7 @@ module Unicorn
     #
     # Default: 5
     #
-    # +delay+: seconds to wait between successive +tries+
+    # +:delay+: seconds to wait between successive +tries+
     #
     # Default: 0.5 seconds
     def listen(address, opt = {})