summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2019-08-07 14:52:02 +0200
committerDaniel Stenberg <daniel@haxx.se>2019-08-07 14:52:02 +0200
commitf23d492777de1fab71d50fe5710d57828a67ba5f (patch)
tree13905002e007704f558c5d906d1f8aac0f60a385 /docs
parent640b9733de74d629af68afcad0ff8bb658e80eff (diff)
downloadcurl-f23d492777de1fab71d50fe5710d57828a67ba5f.tar.gz
docs/EXPERIMENTAL: explain what it means and what's experimental now
Diffstat (limited to 'docs')
-rw-r--r--docs/EXPERIMENTAL.md22
-rw-r--r--docs/Makefile.am1
2 files changed, 23 insertions, 0 deletions
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 \