File eredis-1.7.0-git.patch of Package eredis

Overview Repositories Revisions Requests Users Attributes Meta

File eredis-1.7.0-git.patch of Package eredis (Revision 9038718c87d08602df41a960632c122e)

Currently displaying revision 9038718c87d08602df41a960632c122e , Show latest

diff --git a/README.md b/README.md
index f9edb3c..a935561 100644
--- a/README.md
+++ b/README.md
@@ -204,7 +204,7 @@ response is returned, Eredis is not blocked.
 
 ## Reconnecting on Redis down / network failure / timeout / etc
 
-When Eredis for some reason looses the connection to Redis, Eredis
+When Eredis for some reason loses the connection to Redis, Eredis
 will keep trying to reconnect until a connection is successfully
 established, which includes the `AUTH` and `SELECT` calls. The sleep
 time between attempts to reconnect can be set in the
@@ -223,7 +223,7 @@ immediately with `{connection_error, Reason}`.
 
 Thanks to Dave Peticolas (jdavisp3), eredis supports
 pubsub. [`eredis_sub`](doc/eredis_sub.md) offers a separate client that will forward
-channel messages from Redis to an Erlang process in a "active-once"
+channel messages from Redis to an Erlang process in an "active-once"
 pattern similar to gen_tcp sockets. After every message received, the
 controlling process must acknowledge receipt using
 `eredis_sub:ack_message/1`.
@@ -335,7 +335,7 @@ data arrives on the socket.
 
 ## Tests and code checking
 
-EUnit tests currently requires a locally running instance of Redis.
+EUnit tests currently require a locally running instance of Redis.
 
 ```console
 rebar3 eunit
@@ -357,7 +357,7 @@ reference counted. This could be improved by replacing it with an
 iolist.
 
 When parsing bulk replies, the parser knows the size of the bulk. If the
-bulk is big and would come in many chunks, this could improved by
+bulk is big and would come in many chunks, this could be improved by
 having the client explicitly use `gen_tcp:recv/2` to fetch the entire
 bulk at once.
 
diff --git a/doc/eredis.md b/doc/eredis.md
index cfcc8ba..e98dfbd 100644
--- a/doc/eredis.md
+++ b/doc/eredis.md
@@ -53,7 +53,7 @@ obfuscated() = fun(() -&gt; iodata())
 
 
 <pre><code>
-option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {password, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
+option() = {host, string() | {local, string()}} | {port, <a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {password, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="https://www.erlang.org/doc/man/ssl.html#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
 </code>
 </pre>
 
@@ -154,7 +154,7 @@ always be binaries.
 ### q/3 ###
 
 <pre><code>
-q(Client::<a href="#type-client">client()</a>, Command::[any()], Timeout::integer()) -&gt; {ok, <a href="#type-return_value">return_value()</a>} | {error, Reason::binary() | no_connection}
+q(Client::<a href="#type-client">client()</a>, Command::[any()], Timeout::timeout()) -&gt; {ok, <a href="#type-return_value">return_value()</a>} | {error, Reason::binary() | no_connection}
 </code>
 </pre>
 
@@ -225,7 +225,7 @@ values returned by each command in the pipeline are returned in a list.
 ### qp/3 ###
 
 <pre><code>
-qp(Client::<a href="#type-client">client()</a>, Pipeline::<a href="#type-pipeline">pipeline()</a>, Timeout::integer()) -&gt; [{ok, <a href="#type-return_value">return_value()</a>} | {error, Reason::binary()}] | {error, no_connection}
+qp(Client::<a href="#type-client">client()</a>, Pipeline::<a href="#type-pipeline">pipeline()</a>, Timeout::timeout()) -&gt; [{ok, <a href="#type-return_value">return_value()</a>} | {error, Reason::binary()}] | {error, no_connection}
 </code>
 </pre>
 
@@ -305,7 +305,7 @@ start_link(Options::<a href="#type-options">options()</a>) -&gt; {ok, pid()} | {
 <dd>A 0-ary function that returns the password
   (the preferred way to provide password as it prevents the actual secret from
   appearing in logs and stacktraces), a string or iodata or the
-  atom <code>undefined</code> for no username; default <code>undefined</code>
+  atom <code>undefined</code> for no password; default <code>undefined</code>
 </dd>
 
 
@@ -383,7 +383,7 @@ Connect with the given options.
 ### start_link/2 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>) -&gt; {ok, Pid::pid()} | {error, Reason::term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>) -&gt; {ok, Pid::pid()} | {error, Reason::term()}
 </code>
 </pre>
 
@@ -397,7 +397,7 @@ Connect to the given host and port.
 ### start_link/3 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>, OptionsOrDatabase) -&gt; {ok, Pid::pid()} | {error, Reason::term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>, OptionsOrDatabase) -&gt; {ok, Pid::pid()} | {error, Reason::term()}
 </code>
 </pre>
 
@@ -410,7 +410,7 @@ __This function is deprecated:__ Use [`start_link/1`](#start_link-1) instead.
 ### start_link/4 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>, Database::integer(), Password::string()) -&gt; {ok, pid()} | {error, term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>, Database::integer(), Password::string()) -&gt; {ok, pid()} | {error, term()}
 </code>
 </pre>
 
@@ -424,7 +424,7 @@ __See also:__ [start_link/1](#start_link-1).
 ### start_link/5 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>) -&gt; {ok, pid()} | {error, term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>) -&gt; {ok, pid()} | {error, term()}
 </code>
 </pre>
 
@@ -438,7 +438,7 @@ __See also:__ [start_link/1](#start_link-1).
 ### start_link/6 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>, ConnectTimeout::timeout()) -&gt; {ok, pid()} | {error, term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>, ConnectTimeout::timeout()) -&gt; {ok, pid()} | {error, term()}
 </code>
 </pre>
 
@@ -452,7 +452,7 @@ __See also:__ [start_link/1](#start_link-1).
 ### start_link/7 ###
 
 <pre><code>
-start_link(Host::<a href="#type-host">host()</a>, Port::<a href="inet.md#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>, ConnectTimeout::timeout(), SocketOptions::list()) -&gt; {ok, pid()} | {error, term()}
+start_link(Host::<a href="#type-host">host()</a>, Port::<a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>, Database::integer(), Password::string(), ReconnectSleep::<a href="#type-reconnect_sleep">reconnect_sleep()</a>, ConnectTimeout::timeout(), SocketOptions::list()) -&gt; {ok, pid()} | {error, term()}
 </code>
 </pre>
 
diff --git a/doc/eredis_sub.md b/doc/eredis_sub.md
index 591b2ff..612ba7d 100644
--- a/doc/eredis_sub.md
+++ b/doc/eredis_sub.md
@@ -41,7 +41,7 @@ obfuscated() = fun(() -&gt; iodata())
 
 
 <pre><code>
-option() = {host, string() | {local, string()}} | {port, <a href="inet.md#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {password, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="ssl.md#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
+option() = {host, string() | {local, string()}} | {port, <a href="https://www.erlang.org/doc/man/inet.html#type-port_number">inet:port_number()</a>} | {database, integer()} | {username, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {password, iodata() | <a href="#type-obfuscated">obfuscated()</a> | undefined} | {reconnect_sleep, <a href="#type-reconnect_sleep">reconnect_sleep()</a>} | {connect_timeout, integer()} | {socket_options, list()} | {tls, [<a href="https://www.erlang.org/doc/man/ssl.html#type-tls_client_option">ssl:tls_client_option()</a>]} | {name, <a href="#type-registered_name">registered_name()</a>} | {sentinel, list()}
 </code>
 </pre>
 
diff --git a/rebar.config b/rebar.config
index 5cd2cc9..dca8d1f 100644
--- a/rebar.config
+++ b/rebar.config
@@ -38,11 +38,9 @@
               ]}.
 
 {edoc_opts, [ {doclet, edown_doclet}
-            , {dialyzer_specs, all}
-            , {report_missing_type, true}
-            , {report_type_mismatch, true}
-            , {pretty_print, erl_pp}
+            , {report_missing_types, true}
             , {preprocess, true}
+            , {app_default, "https://www.erlang.org/doc/man"}
             ]}.
 
 {profiles, [{docs, [{deps,
diff --git a/src/eredis.erl b/src/eredis.erl
index c289734..80dcc62 100644
--- a/src/eredis.erl
+++ b/src/eredis.erl
@@ -55,7 +55,7 @@ start_link() ->
 %% <dt>`{password, Password}'</dt><dd>A 0-ary function that returns the password
 %% (the preferred way to provide password as it prevents the actual secret from
 %% appearing in logs and stacktraces), a string or iodata or the
-%% atom `undefined' for no username; default `undefined'</dd>
+%% atom `undefined' for no password; default `undefined'</dd>
 %% <dt>`{reconnect_sleep, ReconnectSleep}'</dt><dd>Integer of milliseconds to
 %% sleep between reconnect attempts; default: 100</dd>
 %% <dt>`{connect_timeout, Timeout}'</dt><dd>Timeout value in milliseconds to use
@@ -150,7 +150,7 @@ stop(Client) ->
 q(Client, Command) ->
     call(Client, Command, ?TIMEOUT).
 
--spec q(Client::client(), Command::[any()], Timeout::integer()) ->
+-spec q(Client::client(), Command::[any()], Timeout::timeout()) ->
           {ok, return_value()} | {error, Reason::binary() | no_connection}.
 %% @doc Like q/2 with a custom timeout.
 q(Client, Command, Timeout) ->
@@ -167,7 +167,7 @@ q(Client, Command, Timeout) ->
 qp(Client, Pipeline) ->
     pipeline(Client, Pipeline, ?TIMEOUT).
 
--spec qp(Client::client(), Pipeline::pipeline(), Timeout::integer()) ->
+-spec qp(Client::client(), Pipeline::pipeline(), Timeout::timeout()) ->
           [{ok, return_value()} | {error, Reason::binary()}] |
           {error, no_connection}.
 %% @doc Like qp/2 with a custom timeout.

Places

File eredis-1.7.0-git.patch of Package eredis (Revision 9038718c87d08602df41a960632c122e)

Places