From 435d43d6b85481e7b678c3092dec7fcb246e30e8 Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Sat, 12 Nov 2011 11:57:17 +0000
Subject: [PATCH] backend: document pipeline_dispatch behavior

It's tricky, but possible to get right (at least for list_keys)
---
 lib/mogilefs/backend.rb | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lib/mogilefs/backend.rb b/lib/mogilefs/backend.rb
index 93bcfe6..596e320 100644
--- a/lib/mogilefs/backend.rb
+++ b/lib/mogilefs/backend.rb
@@ -209,7 +209,10 @@ class MogileFS::Backend
   end
 
   # dispatch a request like do_request, but queue +block+ for execution
-  # upon receiving a response.
+  # upon receiving a response.  It is the users' responsibility to ensure
+  # &block is executed in the correct order.  Trackers with multiple
+  # queryworkers are not guaranteed to return responses in the same
+  # order they were requested.
   def pipeline_dispatch(cmd, args, &block) # :nodoc:
     request = make_request(cmd, args)
     timeout = @timeout
-- 
2.11.4.GIT