[erlang-patches] Patch: Documentation - improve httpc documentation

Jesper Louis Andersen <>
Sat Jun 9 23:07:46 CEST 2012


Hi OTP team

This documentation patch elaborates that timeouts in the httpc 
set_options/1 call are in milliseconds by making it explicit. I used the 
source to determine this twice now and it would be good if the 
documentation reflected it so others do not have to search the source 
code. In Erlang, you have the hunch that it is ms, but it is nice to be 
sure. It looks like either Ingela Anderton Andin or Micael Karlberg 
could be reviewers of its correctness according to a git annotate on the 
httpc_manager. The patch is fetchable from:

git fetch git://github.com/jlouis/otp.git jl-httpc-doc-elaborate

For discussion, the patch is provided below. I have verified it looks ok 
in html documentation and man-pages.

1bc041bd68040220081e8af275701f92f4a07aae Elaborate on timeouts in the 
httpc docu
diff --git a/lib/inets/doc/src/httpc.xml b/lib/inets/doc/src/httpc.xml
index 70c845b..f032ac9 100644
--- a/lib/inets/doc/src/httpc.xml
+++ b/lib/inets/doc/src/httpc.xml
@@ -488,7 +488,7 @@ apply(Module, Function, [ReplyInfo | Args])
<v>KeepAliveTimeout = integer() </v>
<d>Default is <c>120000</c> (= 2 min).
            If a persistent connection is idle longer than the
- <c>keep_alive_timeout</c> the client will close the connection.
+ <c>keep_alive_timeout</c> in milliseconds, the client will close the
            The server may also have such a time out but you should
            not count on it!</d>
<v>MaxPipeline = integer() </v>
@@ -498,7 +498,7 @@ apply(Module, Function, [ReplyInfo | Args])
<d>Default is <c>0</c>,
            which will result in pipelining not being used.
            If a persistent connection is idle longer than the
- <c>pipeline_timeout</c> the client will close the connection. </d>
+ <c>pipeline_timeout</c> in milliseconds the client will close the con
<v>CookieMode = enabled | disabled | verify </v>
<d>Default is <c>disabled</c>.
            If Cookies are enabled all valid cookies will automatically be

-- 
  Jesper Louis Andersen
    Erlang Solutions Ltd., Copenhagen, DK


More information about the erlang-patches mailing list