Merge pull request #694 from kianmeng/fix-typos

Fix typos

Author: benoitc

NEWS.md

@@ -14,7 +14,7 @@
 1.17.3 - 2021-03-17
 -------------------
 
-- fix: ensure we release a socket in the pool when the requester died before beeing monitored.
+- fix: ensure we release a socket in the pool when the requester died before being monitored.
 
 1.17.2 - 2021-03-16
 -------------------
@@ -132,7 +132,7 @@ systems using URL as signature or in an hash.
 - bump to idna 0.6.0
 - fix support of rebar2
 - fix specs
-- add `hackney:sockname/1` adn `hackney:peername/1` functions
+- add `hackney:sockname/1` and `hackney:peername/1` functions
 - add new `checkout_timeout` option for clarity
 - improve `hackney_url:parse_qs/1` to trim leading and trailing empty values
 
@@ -444,7 +444,7 @@ systems using URL as signature or in an hash.
 ------------------
 
 - improvement: Do not wait to cancel a request
-- improvement: do not control the request premptively
+- improvement: do not control the request preemptively
 
 1.0.4 - 2014/12/8
 -----------------
@@ -537,7 +537,7 @@ supported release of hackney.
 ### Breaking change:
 
 When doing an HEAD request, the signature of the response when it
-succeded is now `{ok, Status, ResponseHeaders}` and do not contains a
+succeeded is now `{ok, Status, ResponseHeaders}` and do not contains a
 client reference any more.
 
 
@@ -684,7 +684,7 @@ service release with a new feature and some minor improvements
 
 - added the support for [socks5
   proxies](https://github.com/benoitc/hackney#socks5-proxy)
-- improvment: integer and atom can now be passed in url params or forms
+- improvement: integer and atom can now be passed in url params or forms
   values.
 - breaking change: differentiate connect/recv timeout, now connect
   timeout return `{error, connect_timeout}`
@@ -710,7 +710,7 @@ used for async response requests.
   process is killed.
 - fix: make sure we pass a `Transfer-Encoding: chunked` header when we
   send a body without content-length.
-- fix: make sure the client is correcly reconnected when we reuse a
+- fix: make sure the client is correctly reconnected when we reuse a
   reference.
 
 0.7.0 - 2013/11/22
@@ -768,7 +768,7 @@ fix: fix file upload content type
 0.4.2 - 2013/06/10
 ------------------
 
-- handle `identity` transfert encoding. When the connection close return
+- handle `identity` transfer encoding. When the connection close return
   latest buffer.
 
 0.4.1 - 2013/06/10
@@ -806,7 +806,7 @@ and maybe use the partial body.
 
 - Add Multipart support
 - Add HTTP Proxy tunneling support
-- Fix Chuncked Response decoding
+- Fix Chunked Response decoding
 
 0.2.0 - 2012/07/18
 ------------------

README.md

@@ -171,7 +171,7 @@ read_body(MaxLength, Ref, Acc) when MaxLength > byte_size(Acc) ->
 > Note: you can also fetch a multipart response using the functions
 > `hackney:stream_multipart/1` and  `hackney:skip_multipart/1`.
 
-> Note 2: using the `with_body` option will return the body directy instead of a reference.
+> Note 2: using the `with_body` option will return the body directly instead of a reference.
 
 ### Reuse a connection
 
@@ -327,7 +327,7 @@ LoopFun(LoopFun, ClientRef).
 > example [test_async_once2](https://github.com/benoitc/hackney/blob/master/examples/test_async_once2.erl) for the usage.
 
 > **Note 4**:  When the option `{follow_redirect, true}` is passed to
-> the request, you will receive the folllowing messages on valid
+> the request, you will receive the following messages on valid
 > redirection:
 > - `{redirect, To, Headers}`
 > - `{see_other, To, Headers}` for status 303 and POST requests.

doc/README.md

@@ -171,7 +171,7 @@ read_body(MaxLength, Ref, Acc) when MaxLength > byte_size(Acc) ->
 > Note: you can also fetch a multipart response using the functions
 > `hackney:stream_multipart/1` and  `hackney:skip_multipart/1`.
 
-> Note 2: using the `with_body` option will return the body directy instead of a reference.
+> Note 2: using the `with_body` option will return the body directly instead of a reference.
 
 ### Reuse a connection
 
@@ -327,7 +327,7 @@ LoopFun(LoopFun, ClientRef).
 > example [test_async_once2](https://github.com/benoitc/hackney/blob/master/examples/test_async_once2.erl) for the usage.
 
 > **Note 4**:  When the option `{follow_redirect, true}` is passed to
-> the request, you will receive the folllowing messages on valid
+> the request, you will receive the following messages on valid
 > redirection:
 > - `{redirect, To, Headers}`
 > - `{see_other, To, Headers}` for status 303 and POST requests.

doc/hackney.md

@@ -45,7 +45,7 @@ url() = #hackney_url{} | binary()
 
 
 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#body-1">body/1</a></td><td>Return the full body sent with the response.</td></tr><tr><td valign="top"><a href="#body-2">body/2</a></td><td>Return the full body sent with the response as long as the body
-length doesn't go over MaxLength.</td></tr><tr><td valign="top"><a href="#cancel_request-1">cancel_request/1</a></td><td>Extract raw informations from the client context
+length doesn't go over MaxLength.</td></tr><tr><td valign="top"><a href="#cancel_request-1">cancel_request/1</a></td><td>Extract raw information from the client context
 This feature can be useful when you want to create a simple proxy, rerouting
 on the headers and the status line and continue to forward the connection for example.</td></tr><tr><td valign="top"><a href="#close-1">close/1</a></td><td>close the client.</td></tr><tr><td valign="top"><a href="#connect-1">connect/1</a></td><td></td></tr><tr><td valign="top"><a href="#connect-2">connect/2</a></td><td></td></tr><tr><td valign="top"><a href="#connect-3">connect/3</a></td><td>connect a socket and create a client state.</td></tr><tr><td valign="top"><a href="#connect-4">connect/4</a></td><td></td></tr><tr><td valign="top"><a href="#controlling_process-2">controlling_process/2</a></td><td>Assign a new controlling process <em>Pid</em> to <em>Client</em>.</td></tr><tr><td valign="top"><a href="#cookies-1">cookies/1</a></td><td></td></tr><tr><td valign="top"><a href="#finish_send_body-1">finish_send_body/1</a></td><td></td></tr><tr><td valign="top"><a href="#location-1">location/1</a></td><td>return the requested location.</td></tr><tr><td valign="top"><a href="#pause_stream-1">pause_stream/1</a></td><td>pause a response stream, the stream process will hibernate and
 be woken later by the resume function.</td></tr><tr><td valign="top"><a href="#peername-1">peername/1</a></td><td>peername of the client.</td></tr><tr><td valign="top"><a href="#redirect_location-1">redirect_location/1</a></td><td></td></tr><tr><td valign="top"><a href="#request-1">request/1</a></td><td>make a request.</td></tr><tr><td valign="top"><a href="#request-2">request/2</a></td><td>make a request.</td></tr><tr><td valign="top"><a href="#request-3">request/3</a></td><td>make a request.</td></tr><tr><td valign="top"><a href="#request-4">request/4</a></td><td>make a request.</td></tr><tr><td valign="top"><a href="#request-5">request/5</a></td><td>make a request.</td></tr><tr><td valign="top"><a href="#request_info-1">request_info/1</a></td><td>get request info.</td></tr><tr><td valign="top"><a href="#resume_stream-1">resume_stream/1</a></td><td>resume a paused response stream, the stream process will be
@@ -112,7 +112,7 @@ cancel_request(Ref::<a href="#type-client_ref">client_ref()</a>) -&gt; {ok, {ato
 </code></pre>
 <br />
 
-Extract raw informations from the client context
+Extract raw information from the client context
 This feature can be useful when you want to create a simple proxy, rerouting
 on the headers and the status line and continue to forward the connection for example.
 

doc/hackney_headers_new.md

@@ -55,7 +55,7 @@ value() = binary() | {binary() | [{binary(), binary()} | binary()]}
 
 
 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#append-3">append/3</a></td><td>append a new value to the list of value for the the header field
-if the key has not been recorded the list will be created with the value as the first item.</td></tr><tr><td valign="top"><a href="#delete-2">delete/2</a></td><td>delete a field from headers.</td></tr><tr><td valign="top"><a href="#fold-3">fold/3</a></td><td></td></tr><tr><td valign="top"><a href="#from_list-1">from_list/1</a></td><td>create headers from a list.</td></tr><tr><td valign="top"><a href="#get_value-2">get_value/2</a></td><td>get the first value of an headers or return undefined.</td></tr><tr><td valign="top"><a href="#get_value-3">get_value/3</a></td><td>get the first value of an headers or return the default.</td></tr><tr><td valign="top"><a href="#is_key-2">is_key/2</a></td><td>is the header field exists or no.</td></tr><tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td></td></tr><tr><td valign="top"><a href="#merge-2">merge/2</a></td><td>merge 2 headers objects.</td></tr><tr><td valign="top"><a href="#new-0">new/0</a></td><td>initialize an empty headers objecy.</td></tr><tr><td valign="top"><a href="#new-1">new/1</a></td><td></td></tr><tr><td valign="top"><a href="#parse_content_type-1">parse_content_type/1</a></td><td></td></tr><tr><td valign="top"><a href="#parse_media_type-2">parse_media_type/2</a></td><td>Parse a media type.</td></tr><tr><td valign="top"><a href="#size-1">size/1</a></td><td>return the number of headers fields.</td></tr><tr><td valign="top"><a href="#store-2">store/2</a></td><td>store a list of headers.</td></tr><tr><td valign="top"><a href="#store-3">store/3</a></td><td>replace the content of the header field with the value or the list of values.</td></tr><tr><td valign="top"><a href="#store_new-3">store_new/3</a></td><td>only store a vakue if the key exist.</td></tr><tr><td valign="top"><a href="#to_binary-1">to_binary/1</a></td><td>transform headers to a binary that can be used to construct a request.</td></tr><tr><td valign="top"><a href="#to_iolist-1">to_iolist/1</a></td><td>conver headers to an iolist.</td></tr><tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td>convert headers to a list.</td></tr></table>
+if the key has not been recorded the list will be created with the value as the first item.</td></tr><tr><td valign="top"><a href="#delete-2">delete/2</a></td><td>delete a field from headers.</td></tr><tr><td valign="top"><a href="#fold-3">fold/3</a></td><td></td></tr><tr><td valign="top"><a href="#from_list-1">from_list/1</a></td><td>create headers from a list.</td></tr><tr><td valign="top"><a href="#get_value-2">get_value/2</a></td><td>get the first value of an headers or return undefined.</td></tr><tr><td valign="top"><a href="#get_value-3">get_value/3</a></td><td>get the first value of an headers or return the default.</td></tr><tr><td valign="top"><a href="#is_key-2">is_key/2</a></td><td>is the header field exists or no.</td></tr><tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td></td></tr><tr><td valign="top"><a href="#merge-2">merge/2</a></td><td>merge 2 headers objects.</td></tr><tr><td valign="top"><a href="#new-0">new/0</a></td><td>initialize an empty headers objecy.</td></tr><tr><td valign="top"><a href="#new-1">new/1</a></td><td></td></tr><tr><td valign="top"><a href="#parse_content_type-1">parse_content_type/1</a></td><td></td></tr><tr><td valign="top"><a href="#parse_media_type-2">parse_media_type/2</a></td><td>Parse a media type.</td></tr><tr><td valign="top"><a href="#size-1">size/1</a></td><td>return the number of headers fields.</td></tr><tr><td valign="top"><a href="#store-2">store/2</a></td><td>store a list of headers.</td></tr><tr><td valign="top"><a href="#store-3">store/3</a></td><td>replace the content of the header field with the value or the list of values.</td></tr><tr><td valign="top"><a href="#store_new-3">store_new/3</a></td><td>only store a value if the key exist.</td></tr><tr><td valign="top"><a href="#to_binary-1">to_binary/1</a></td><td>transform headers to a binary that can be used to construct a request.</td></tr><tr><td valign="top"><a href="#to_iolist-1">to_iolist/1</a></td><td>convert headers to an iolist.</td></tr><tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td>convert headers to a list.</td></tr></table>
 
 
 <a name="functions"></a>
@@ -150,7 +150,7 @@ merge(Headers1::<a href="#type-headers">headers()</a>, X2::<a href="#type-header
 </code></pre>
 <br />
 
-merge 2 headers objects. If a key is already exising in HEader1, it will be kept.
+merge 2 headers objects. If a key is already existing in HEader1, it will be kept.
 
 <a name="new-0"></a>
 
@@ -234,7 +234,7 @@ store_new(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value
 </code></pre>
 <br />
 
-only store a vakue if the key exist.
+only store a value if the key exist.
 
 <a name="to_binary-1"></a>
 
@@ -256,7 +256,7 @@ to_iolist(Headers::<a href="#type-headers">headers()</a>) -&gt; iolist()
 </code></pre>
 <br />
 
-conver headers to an iolist. Useful to send them over the wire.
+convert headers to an iolist. Useful to send them over the wire.
 
 <a name="to_list-1"></a>
 

doc/overview.edoc

@@ -180,7 +180,7 @@ read_body(MaxLength, Ref, Acc) when MaxLength > byte_size(Acc) ->
 > Note: you can also fetch a multipart response using the functions
 > `hackney:stream_multipart/1` and  `hackney:skip_multipart/1'.
 
-> Note 2: using the `with_body' option will return the body directy instead of a reference.
+> Note 2: using the `with_body' option will return the body directly instead of a reference.
 
 ### Reuse a connection
 
@@ -329,7 +329,7 @@ LoopFun(LoopFun, ClientRef).</pre>
 > example [test_async_once2](https://github.com/benoitc/hackney/blob/master/examples/test_async_once2.erl) for the usage.
 
 > **Note 4**:  When the option `{follow_redirect, true}' is passed to
-> the request, you will receive the folllowing messages on valid
+> the request, you will receive the following messages on valid
 > redirection:
 > - `{redirect, To, Headers}'
 > - `{see_other, To, Headers}' for status 303 and POST requests.

src/hackney.erl

@@ -75,7 +75,7 @@ connect(Transport, Host, Port, Options) ->
 controlling_process(Ref, Pid) ->
   hackney_manager:controlling_process(Ref, Pid).
 
-%% @doc Extract raw informations from the client context
+%% @doc Extract raw information from the client context
 %% This feature can be useful when you want to create a simple proxy, rerouting
 %% on the headers and the status line and continue to forward the connection for example.
 %%

src/hackney_headers_new.erl

@@ -87,7 +87,7 @@ store(KVs, Headers) when is_list(KVs) ->
     KVs
    ).
 
-%% @doc only store a vakue if the key exist.
+%% @doc only store a value if the key exist.
 -spec store_new(key(), value(), headers()) -> {boolean(), headers()}.
 store_new(Key, Value, {_N, DictHeaders}=Headers) ->
   KL = ?kl(Key),
@@ -148,7 +148,7 @@ do_fold([{_, Key, Value} | Rest], Fun, Acc) ->
   do_fold(Rest, Fun, Fun(Key, Value, Acc));
 do_fold([], _Fun, Acc) -> Acc.
 
-%% @doc merge 2 headers objects. If a key is already exising in HEader1, it will be kept.
+%% @doc merge 2 headers objects. If a key is already existing in HEader1, it will be kept.
 -spec merge(headers(), headers()) -> headers().
 merge(Headers1, {_, DictHeaders2}) ->
   dict:fold(
@@ -178,7 +178,7 @@ to_list(Headers) ->
   ),
   lists:reverse(Result).
 
-%% @doc conver headers to an iolist. Useful to send them over the wire.
+%% @doc convert headers to an iolist. Useful to send them over the wire.
 -spec to_iolist(headers()) -> iolist().
 to_iolist(Headers) ->
   L = fold(

src/hackney_http_connect.erl

@@ -62,7 +62,7 @@ connect(ProxyHost, ProxyPort, Opts, Timeout)
     {nodelay, true}],
   ConnectOpts = hackney_util:filter_options(Opts, AcceptedOpts, BaseOpts),
 
-  %% connnect to the proxy, and upgrade the socket if needed.
+  %% connect to the proxy, and upgrade the socket if needed.
   case gen_tcp:connect(ProxyHost, ProxyPort, ConnectOpts) of
     {ok, Socket} ->
       case do_handshake(Socket, Host, Port, Opts) of

src/hackney_manager.erl

@@ -59,7 +59,7 @@ new_request(Client) ->
 init_request(InitialState) ->
   %% initialize the request
   Ref = make_ref(),
-  %% store the current state in the process dictionnary
+  %% store the current state in the process dictionary
   put(Ref, InitialState#client{request_ref=Ref}),
   %% supervise the process owner
   {ok, StartTime} = gen_server:call(?MODULE, {new_request, self(), Ref,
@@ -160,15 +160,15 @@ start_async_response(Ref) ->
       case gen_server:call(?MODULE, {start_async_response, Ref,
         StreamTo, Client}) of
         {ok, Pid} ->
-          %% store temporarely the socket in the the ets so it can
+          %% store temporarily the socket in the the ets so it can
           %% be used by the other process later
           true = ets:insert(?MODULE, {Ref, #request{ref=Ref,
             state=Client}}),
-          %% delete the current state from the process dictionnary
+          %% delete the current state from the process dictionary
           %% since it's not the owner
           erase(Ref),
 
-          %% transfert the control of the socket
+          %% transfer the control of the socket
           case Transport:controlling_process(Socket, Pid) of
             ok -> Pid ! controlling_process_done, ok;
             Else -> Else
@@ -470,7 +470,7 @@ handle_stream_exit(Pid, Ref, Reason, State) ->
     [{Ref, {Owner, Pid, #request_info{pool=Pool}=Info}}] ->
       %% untrack the owner
       Pids2 = untrack_owner(Owner, Ref, Pids1),
-      %% if anormal reason let the owner knows
+      %% if abnormal reason let the owner knows
       _ = case Reason of
             normal ->  ok;
             {owner_down, Owner, _} -> ok; %% we were streaming to