From d199947566d5783ce2b56338d45d262712ff7151 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Thu, 15 Dec 2011 04:03:33 +0000
Subject: docs for various timeouts in MogileFS::MogileFS.new

We have lots of timeouts :x
---
 lib/mogilefs/mogilefs.rb | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/lib/mogilefs/mogilefs.rb b/lib/mogilefs/mogilefs.rb
index 819f69a..898c0de 100644
--- a/lib/mogilefs/mogilefs.rb
+++ b/lib/mogilefs/mogilefs.rb
@@ -34,7 +34,8 @@ class MogileFS::MogileFS < MogileFS::Client
   # The domain of keys for this MogileFS client.
   attr_accessor :domain
 
-  # The timeout for get_file_data.  Defaults to five seconds.
+  # The timeout for get_file_data (per-read() system call).
+  # Defaults to five seconds.
   attr_accessor :get_file_data_timeout
 
   # The maximum allowed time for creating a new_file.  Defaults to 1 hour.
@@ -42,6 +43,27 @@ class MogileFS::MogileFS < MogileFS::Client
 
   # Creates a new MogileFS::MogileFS instance.  +args+ must include a key
   # :domain specifying the domain of this client.
+  #
+  # Optional parameters for +args+:
+  #
+  # [:get_file_data_timeout => Numeric]
+  #
+  #   See get_file_data_timeout
+  #
+  # [:new_file_max_time => Numeric]
+  #
+  #   See new_file_max_time
+  #
+  # [:fail_timeout => Numeric]
+  #
+  #   Delay before retrying a failed tracker backends.
+  #   Defaults to 5 seconds.
+  #
+  # [:timeout => Numeric]
+  #
+  #   Timeout for tracker backend responses.
+  #   Defaults to 3 seconds.
+  #
   def initialize(args = {})
     @domain = args[:domain]
 
-- 
cgit v1.2.3-24-ge0c7