diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/guide/book.asciidoc | 2 | ||||
| -rw-r--r-- | doc/src/guide/migrating_from_2.1.asciidoc | 49 | ||||
| -rw-r--r-- | doc/src/manual/ranch_transport.asciidoc | 1 |
3 files changed, 52 insertions, 0 deletions
diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc index ce3071e..cde3335 100644 --- a/doc/src/guide/book.asciidoc +++ b/doc/src/guide/book.asciidoc @@ -29,6 +29,8 @@ include::internals.asciidoc[Internals] = Additional information +include::migrating_from_2.1.asciidoc[Migrating from Ranch 2.1 to 2.2] + include::migrating_from_2.0.asciidoc[Migrating from Ranch 2.0 to 2.1] include::migrating_from_1.7.asciidoc[Migrating from Ranch 1.7 to 2.0] diff --git a/doc/src/guide/migrating_from_2.1.asciidoc b/doc/src/guide/migrating_from_2.1.asciidoc new file mode 100644 index 0000000..7cec7c8 --- /dev/null +++ b/doc/src/guide/migrating_from_2.1.asciidoc @@ -0,0 +1,49 @@ +[appendix] +== Migrating from Ranch 2.1 to Ranch 2.2 + +Ranch 2.2 is a maintenance release containing a small number +of fixes and improvements. + +Ranch 2.2 is tested with Erlang/OTP 24.0 onward, although it +should be compatible with Erlang/OTP 22.0 and above. + +=== Features added + +* `DTLS` is now supported. + +* The `certs_keys` option from `ssl` is now accepted + and documented. + +* The `UNIQUE_ID` PROXY protocol header extension is + now supported. + +* The `ranch_transport` behavior has a new callback + `format_error/1` which allows finer grained formatting + of Ranch's error messages. The callback is currently + optional and will become required in Ranch 3.0. + +=== Changed behaviors + +* Ranch will now obfuscate certificates, keys and passwords + in the error message produced on listen error. + +* The exception reason when a connection process has failed + its handshake has been changed to `{shutdown, {Reason, PeerInfo}}` + where `PeerInfo` contains the peer name when available. + +* The `{packet, raw}` socket option is no longer set explicitly, + as this is already the default value. + +=== Bugs fixed + +* `ranch:stop_listener/1` will now return an error instead + of throwing an exception when the listener does not exist. + +* Fix `ranch:recv_proxy_header/2` for the upcoming Erlang/OTP 28. + +* Ensure that a user crash while stopping a listener does + not prevent a subsequent attempt to stop it. + +* Alarm option `threshold` was mispelled in Ranch 2.1. This + has been corrected. The wrong spelling `treshold` is still + accepted and will be removed in Ranch 3.0. diff --git a/doc/src/manual/ranch_transport.asciidoc b/doc/src/manual/ranch_transport.asciidoc index 4717281..a4c90d0 100644 --- a/doc/src/manual/ranch_transport.asciidoc +++ b/doc/src/manual/ranch_transport.asciidoc @@ -354,6 +354,7 @@ The exact type will vary depending on the transport module. == Changelog +* *2.2*: The callback `format_error/1` was added. * *2.0*: The callback `listen/1` has changed to accept a map of transport options instead of socket options. * *2.0*: The callback `messages/0` return value was updated to |