Skip to content

Commit

Permalink
bum changelog and regenerate the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
benoitc committed Apr 3, 2018
1 parent 74fe3db commit d2661ef
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 9 deletions.
13 changes: 13 additions & 0 deletions NEWS.md
@@ -1,5 +1,18 @@
# NEWS

1.12.0 -- 2018-04-03
--------------------

- fix socks5 badarg error when an IP is given
- upgrade IDNA to 5.1.1
- upgrade certifi to 2.3.1
- fix handling of requests with content-length or transfer-encoding given (#475)
- improvments: send SNI in socks5 SSL
- fix: Allow trailing spaces at the end of chunk sizes (#489)
- fix: set once the metrics engine
- fix leak in the socket pool (#462)
- fix doc

1.11.0 - 2018-01-23
-------------------

Expand Down
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2012-2018 Benoît Chesneau.

__Version:__ 1.11.0
__Version:__ 1.12.0

# hackney

Expand Down Expand Up @@ -533,6 +533,7 @@ $ kill `cat httpbin.pid`
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_http_connect.md" class="module">hackney_http_connect</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_local_tcp.md" class="module">hackney_local_tcp</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_manager.md" class="module">hackney_manager</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_metrics.md" class="module">hackney_metrics</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_pool.md" class="module">hackney_pool</a></td></tr>
<tr><td><a href="http://github.com/benoitc/hackney/blob/master/doc/hackney_pool_handler.md" class="module">hackney_pool_handler</a></td></tr>
Expand Down
3 changes: 2 additions & 1 deletion doc/README.md
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2012-2018 Benoît Chesneau.

__Version:__ 1.11.0
__Version:__ 1.12.0

# hackney

Expand Down Expand Up @@ -533,6 +533,7 @@ $ kill `cat httpbin.pid`
<tr><td><a href="hackney_http_connect.md" class="module">hackney_http_connect</a></td></tr>
<tr><td><a href="hackney_local_tcp.md" class="module">hackney_local_tcp</a></td></tr>
<tr><td><a href="hackney_manager.md" class="module">hackney_manager</a></td></tr>
<tr><td><a href="hackney_metrics.md" class="module">hackney_metrics</a></td></tr>
<tr><td><a href="hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
<tr><td><a href="hackney_pool.md" class="module">hackney_pool</a></td></tr>
<tr><td><a href="hackney_pool_handler.md" class="module">hackney_pool_handler</a></td></tr>
Expand Down
7 changes: 4 additions & 3 deletions doc/edoc-info
Expand Up @@ -3,6 +3,7 @@
{modules,[hackney,hackney_app,hackney_bstr,hackney_connect,hackney_cookie,
hackney_date,hackney_headers,hackney_headers_new,hackney_http,
hackney_http_connect,hackney_local_tcp,hackney_manager,
hackney_multipart,hackney_pool,hackney_pool_handler,hackney_request,
hackney_response,hackney_socks5,hackney_ssl,hackney_stream,
hackney_sup,hackney_tcp,hackney_trace,hackney_url,hackney_util]}.
hackney_metrics,hackney_multipart,hackney_pool,hackney_pool_handler,
hackney_request,hackney_response,hackney_socks5,hackney_ssl,
hackney_stream,hackney_sup,hackney_tcp,hackney_trace,hackney_url,
hackney_util]}.
4 changes: 2 additions & 2 deletions doc/hackney_headers_new.md
Expand Up @@ -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 witht eh 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 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>


<a name="functions"></a>
Expand All @@ -72,7 +72,7 @@ append(Key::<a href="#type-key">key()</a>, Value::<a href="#type-value">value()<
<br />

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 witht eh value as the first item.
if the key has not been recorded the list will be created with the value as the first item.

<a name="delete-2"></a>

Expand Down
8 changes: 7 additions & 1 deletion doc/hackney_pool.md
Expand Up @@ -15,7 +15,7 @@ __Behaviours:__ [`gen_server`](gen_server.md).


<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#checkin-2">checkin/2</a></td><td>release a socket in the pool.</td></tr><tr><td valign="top"><a href="#checkout-4">checkout/4</a></td><td>fetch a socket from the pool.</td></tr><tr><td valign="top"><a href="#child_spec-2">child_spec/2</a></td><td>return a child spec suitable for embeding your pool in the
supervisor.</td></tr><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr><tr><td valign="top"><a href="#count-1">count/1</a></td><td>get the number of connections in the pool.</td></tr><tr><td valign="top"><a href="#count-2">count/2</a></td><td>get the number of connections in the pool for <code>{Host0, Port, Transport}</code></td></tr><tr><td valign="top"><a href="#find_pool-1">find_pool/1</a></td><td></td></tr><tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr><tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#max_connections-1">max_connections/1</a></td><td>get max pool size.</td></tr><tr><td valign="top"><a href="#notify-2">notify/2</a></td><td></td></tr><tr><td valign="top"><a href="#set_max_connections-2">set_max_connections/2</a></td><td>change the pool size.</td></tr><tr><td valign="top"><a href="#set_timeout-2">set_timeout/2</a></td><td>change the connection timeout.</td></tr><tr><td valign="top"><a href="#start-0">start/0</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td></td></tr><tr><td valign="top"><a href="#start_pool-2">start_pool/2</a></td><td>start a pool.</td></tr><tr><td valign="top"><a href="#stop_pool-1">stop_pool/1</a></td><td>stop a pool.</td></tr><tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr><tr><td valign="top"><a href="#timeout-1">timeout/1</a></td><td>get timeout.</td></tr></table>
supervisor.</td></tr><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr><tr><td valign="top"><a href="#count-1">count/1</a></td><td>get the number of connections in the pool.</td></tr><tr><td valign="top"><a href="#count-2">count/2</a></td><td>get the number of connections in the pool for <code>{Host0, Port, Transport}</code></td></tr><tr><td valign="top"><a href="#find_pool-1">find_pool/1</a></td><td></td></tr><tr><td valign="top"><a href="#get_stats-1">get_stats/1</a></td><td></td></tr><tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr><tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr><tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#max_connections-1">max_connections/1</a></td><td>get max pool size.</td></tr><tr><td valign="top"><a href="#notify-2">notify/2</a></td><td></td></tr><tr><td valign="top"><a href="#set_max_connections-2">set_max_connections/2</a></td><td>change the pool size.</td></tr><tr><td valign="top"><a href="#set_timeout-2">set_timeout/2</a></td><td>change the connection timeout.</td></tr><tr><td valign="top"><a href="#start-0">start/0</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td></td></tr><tr><td valign="top"><a href="#start_pool-2">start_pool/2</a></td><td>start a pool.</td></tr><tr><td valign="top"><a href="#stop_pool-1">stop_pool/1</a></td><td>stop a pool.</td></tr><tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr><tr><td valign="top"><a href="#timeout-1">timeout/1</a></td><td>get timeout.</td></tr></table>


<a name="functions"></a>
Expand Down Expand Up @@ -75,6 +75,12 @@ get the number of connections in the pool for `{Host0, Port, Transport}`

`find_pool(Name) -> any()`

<a name="get_stats-1"></a>

### get_stats/1 ###

`get_stats(Pool) -> any()`

<a name="handle_call-3"></a>

### handle_call/3 ###
Expand Down
8 changes: 7 additions & 1 deletion doc/hackney_util.md
Expand Up @@ -9,7 +9,7 @@
## Function Index ##


<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#filter_options-3">filter_options/3</a></td><td>filter a proplists and only keep allowed keys.</td></tr><tr><td valign="top"><a href="#is_ipv6-1">is_ipv6/1</a></td><td></td></tr><tr><td valign="top"><a href="#maybe_apply_defaults-2">maybe_apply_defaults/2</a></td><td></td></tr><tr><td valign="top"><a href="#merge_opts-2">merge_opts/2</a></td><td></td></tr><tr><td valign="top"><a href="#mod_metrics-0">mod_metrics/0</a></td><td></td></tr><tr><td valign="top"><a href="#privdir-0">privdir/0</a></td><td></td></tr><tr><td valign="top"><a href="#require-1">require/1</a></td><td>Start the given applications if they were not already started.</td></tr><tr><td valign="top"><a href="#set_option_default-3">set_option_default/3</a></td><td>set the default options in a proplists if not defined.</td></tr><tr><td valign="top"><a href="#to_atom-1">to_atom/1</a></td><td></td></tr></table>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#filter_options-3">filter_options/3</a></td><td>filter a proplists and only keep allowed keys.</td></tr><tr><td valign="top"><a href="#is_ipv6-1">is_ipv6/1</a></td><td></td></tr><tr><td valign="top"><a href="#maybe_apply_defaults-2">maybe_apply_defaults/2</a></td><td></td></tr><tr><td valign="top"><a href="#merge_opts-2">merge_opts/2</a></td><td></td></tr><tr><td valign="top"><a href="#mod_metrics-0">mod_metrics/0</a></td><td></td></tr><tr><td valign="top"><a href="#privdir-0">privdir/0</a></td><td></td></tr><tr><td valign="top"><a href="#require-1">require/1</a></td><td>Start the given applications if they were not already started.</td></tr><tr><td valign="top"><a href="#set_option_default-3">set_option_default/3</a></td><td>set the default options in a proplists if not defined.</td></tr><tr><td valign="top"><a href="#to_atom-1">to_atom/1</a></td><td></td></tr><tr><td valign="top"><a href="#to_int-1">to_int/1</a></td><td></td></tr></table>


<a name="functions"></a>
Expand Down Expand Up @@ -87,3 +87,9 @@ set the default options in a proplists if not defined

`to_atom(V) -> any()`

<a name="to_int-1"></a>

### to_int/1 ###

`to_int(S) -> any()`

0 comments on commit d2661ef

Please sign in to comment.