aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/gun.info.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2020-03-15 18:41:48 +0100
committerLoïc Hoguin <[email protected]>2020-03-15 18:41:48 +0100
commite37af7ac0caffc661def1593c55b212cc2f05d3e (patch)
tree0e55296085281e8360261394259c9988b4bd83ac /doc/src/manual/gun.info.asciidoc
parent87d0bfff926892d2dc0a55a3dc45d8c5f8a682f3 (diff)
downloadgun-e37af7ac0caffc661def1593c55b212cc2f05d3e.tar.gz
gun-e37af7ac0caffc661def1593c55b212cc2f05d3e.tar.bz2
gun-e37af7ac0caffc661def1593c55b212cc2f05d3e.zip
Document the cookie store option and related modules
Also contains a few small changes and Dialyzer fixes.
Diffstat (limited to 'doc/src/manual/gun.info.asciidoc')
-rw-r--r--doc/src/manual/gun.info.asciidoc7
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/src/manual/gun.info.asciidoc b/doc/src/manual/gun.info.asciidoc
index 8f98942..095492e 100644
--- a/doc/src/manual/gun.info.asciidoc
+++ b/doc/src/manual/gun.info.asciidoc
@@ -6,8 +6,6 @@ gun:info - Obtain information about the connection
== Description
-// @todo Document the cookie_store key when documenting cookies.
-
[source,erlang]
----
info(ConnPid) -> Info
@@ -22,7 +20,8 @@ Info :: #{
sock_port => inet:port_number(),
origin_host => inet:hostname() | inet:ip_address(),
origin_port => inet:port_number(),
- intermediaries => [Intermediary]
+ intermediaries => [Intermediary],
+ cookie_store => gun_cookies:cookie_store()
}
Intermediary :: #{
type => connect | socks5,
@@ -48,7 +47,7 @@ the connection.
== Changelog
-* *2.0*: The value `owner` was added.
+* *2.0*: The values `owner` and `cookie_store` were added.
* *1.3*: The values `socket`, `transport`, `protocol`, `origin_host`,
`origin_port` and `intermediaries` were added.
* *1.0*: Function introduced.