summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmile Joubert <emile@rabbitmq.com>2012-09-14 15:02:09 +0100
committerEmile Joubert <emile@rabbitmq.com>2012-09-14 15:02:09 +0100
commit36637fa8ef9da75466ff98656f37bd72ff5fd921 (patch)
treeac30f4844e8ee5b972b381a1f3c8a9256617aae1
parent70612671f27997b9275010c3bfab91fd70cf3156 (diff)
downloadrabbitmq-server-36637fa8ef9da75466ff98656f37bd72ff5fd921.tar.gz
Tweak docs
-rw-r--r--src/file_handle_cache.erl6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/file_handle_cache.erl b/src/file_handle_cache.erl
index c3c5ed8e..e1fa3d70 100644
--- a/src/file_handle_cache.erl
+++ b/src/file_handle_cache.erl
@@ -120,11 +120,11 @@
%% do not need to worry about their handles being closed by the server
%% - reopening them when necessary is handled transparently.
%%
-%% The server also supports obtain, release and transfer. obtain
+%% The server also supports obtain, release and transfer. obtain/{0,1}
%% blocks until a file descriptor is available, at which point the
%% requesting process is considered to 'own' more descriptor(s).
-%% release is the inverse operation and releases previously obtained
-%% descriptor(s). transfer transfers ownership of file descriptor(s)
+%% release/{0,1} is the inverse operation and releases previously obtained
+%% descriptor(s). transfer/{1,2} transfers ownership of file descriptor(s)
%% between processes. It is non-blocking. Obtain has a
%% lower limit, set by the ?OBTAIN_LIMIT/1 macro. File handles can use
%% the entire limit, but will be evicted by obtain calls up to the