From: Daniel Stenberg <daniel@haxx.se>
Date: Wed, 7 Aug 2019 12:52:02 +0000 (+0200)
Subject: docs/EXPERIMENTAL: explain what it means and what's experimental now
X-Git-Tag: curl-7_66_0~128
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f23d492777de1fab71d50fe5710d57828a67ba5f;p=curl

docs/EXPERIMENTAL: explain what it means and what's experimental now
---

diff --git a/docs/EXPERIMENTAL.md b/docs/EXPERIMENTAL.md
new file mode 100644
index 000000000..6c33bcf53
--- /dev/null
+++ b/docs/EXPERIMENTAL.md
@@ -0,0 +1,22 @@
+# Experimental
+
+Some features and functionality in curl and libcurl are considered
+**EXPERIMENTAL**.
+
+Experimental support in curl means:
+
+1. Experimental features are provided to allow users to try them out and
+   provide feedback on functionality and API etc before they ship and get
+   "carved in stone".
+2. You must enable the feature when invoking configure as otherwise curl will
+   not be built with the feature present.
+3. We strongly advice against using this feature in production.
+4. **We reserve the right to change behavior** of the feature without sticking
+   to our API/ABI rules as we do for regular features, as long as it is marked
+   experimental.
+5. Experimental features are clearly marked so in documentation. Beware.
+
+## Experimental features right now
+
+ - HTTP/3 support and options
+ - alt-svc support and options
diff --git a/docs/Makefile.am b/docs/Makefile.am
index a29c059a1..2bde6bcb1 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -53,6 +53,7 @@ EXTRA_DIST =                                    \
  CODE_STYLE.md                                  \
  CONTRIBUTE.md                                  \
  DEPRECATE.md                                   \
+ EXPERIMENTAL.md                                \
  FAQ                                            \
  FEATURES                                       \
  GOVERNANCE.md                                  \