moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-23 08:38:49 -05:00
Code Issues Releases Wiki Activity

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

Browse Source
This commit is contained in:
Daniel Stenberg 2019-08-07 14:52:02 +02:00
parent 640b9733de
commit f23d492777
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/EXPERIMENTAL.md Normal file
View File

@ -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

1
docs/Makefile.am
View File

@ -53,6 +53,7 @@ EXTRA_DIST = \
CODE_STYLE.md \ CODE_STYLE.md \
CONTRIBUTE.md \ CONTRIBUTE.md \
DEPRECATE.md \ DEPRECATE.md \
EXPERIMENTAL.md \
FAQ \ FAQ \
FEATURES \ FEATURES \
GOVERNANCE.md \ GOVERNANCE.md \