From f5688f4aa425987a1c101ab969fb35e4c3ca012b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 4 Jul 2018 11:02:10 +0200
Subject: Document upcoming changes in Ranch 2.0

---
 doc/src/guide/book.asciidoc                 | 10 ++++++++++
 doc/src/guide/upcoming_2.0_changes.asciidoc | 29 +++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 doc/src/guide/upcoming_2.0_changes.asciidoc

diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
index 59e8e70..c1e9e5d 100644
--- a/doc/src/guide/book.asciidoc
+++ b/doc/src/guide/book.asciidoc
@@ -3,6 +3,8 @@
 
 = Ranch User Guide
 
+= Interface
+
 include::introduction.asciidoc[Introduction]
 
 include::listeners.asciidoc[Listeners]
@@ -13,8 +15,16 @@ include::protocols.asciidoc[Protocols]
 
 include::embedded.asciidoc[Embedded mode]
 
+= How to
+
 include::parsers.asciidoc[Writing parsers]
 
 include::ssl_auth.asciidoc[SSL client authentication]
 
+= Advanced
+
 include::internals.asciidoc[Internals]
+
+= Additional information
+
+include::upcoming_2.0_changes.asciidoc[Upcoming changes in Ranch 2.0]
diff --git a/doc/src/guide/upcoming_2.0_changes.asciidoc b/doc/src/guide/upcoming_2.0_changes.asciidoc
new file mode 100644
index 0000000..40fc4e9
--- /dev/null
+++ b/doc/src/guide/upcoming_2.0_changes.asciidoc
@@ -0,0 +1,29 @@
+== Upcoming changes in Ranch 2.0
+
+The following changes will be done in Ranch 2.0. In most
+cases an alternative is already available in the most
+recent Ranch version.
+
+* The function `ranch:start_listener/6` has been deprecated
+  in favor of `ranch:start_listener/5`. The number of acceptors
+  was removed and will be taken from the transport options.
+
+* The function `ranch:child_spec/6` has also been deprecated,
+  in favor of `ranch:child_spec/5`.
+
+* The function `ranch:accept_ack/1` has been deprecated in
+  favor of `ranch:handshake/1,2`.
+
+* The socket will no longer be passed to the protocol when
+  starting it. It will be available as a return value from
+  `ranch:handshake/1,2` only.
+
+* Starting from Ranch 2.0 it will no longer be allowed to
+  pass Ranch options along with socket options as a proplist.
+  The only forms allowed will be the `ranch:opts()` map or socket
+  options as-is. The `ranch:opts()` map must be used in case socket
+  options also use a map.
+
+* The `socket` option will be removed. A more viable solution
+  is to define a custom transport module that returns a fresh
+  socket when `Transport:listen/1` is called.
-- 
cgit v1.2.3