From 24b6a2455d11ba5139863d53d68d60ca6ad06745 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 11 Nov 2021 10:44:24 -0500 Subject: [PATCH] Document that the "experimental-api" feature is not semver-covered. --- crates/arti-client/Cargo.toml | 5 +++++ crates/tor-circmgr/Cargo.toml | 4 ++++ crates/tor-netdir/Cargo.toml | 5 +++++ 3 files changed, 14 insertions(+) diff --git a/crates/arti-client/Cargo.toml b/crates/arti-client/Cargo.toml index 783e61af0..e619f76d6 100644 --- a/crates/arti-client/Cargo.toml +++ b/crates/arti-client/Cargo.toml @@ -15,6 +15,11 @@ default = [ "tokio" ] async-std = [ "tor-rtcompat/async-std" ] tokio = [ "tor-rtcompat/tokio", "tor-proto/tokio" ] static = [ "tor-rtcompat/static", "tor-dirmgr/static" ] + +# Enable experimental APIs that are not yet officially supported. +# +# These APIs are not covered by semantic versioning. Using this +# feature voids your "semver warrantee". experimental-api = [] [dependencies] diff --git a/crates/tor-circmgr/Cargo.toml b/crates/tor-circmgr/Cargo.toml index 55f4211ca..921c035a4 100644 --- a/crates/tor-circmgr/Cargo.toml +++ b/crates/tor-circmgr/Cargo.toml @@ -11,6 +11,10 @@ categories = [ "network-programming", "cryptography" ] repository="https://gitlab.torproject.org/tpo/core/arti.git/" [features] +# Enable experimental APIs that are not yet officially supported. +# +# These APIs are not covered by semantic versioning. Using this +# feature voids your "semver warrantee". experimental-api = [] [dependencies] diff --git a/crates/tor-netdir/Cargo.toml b/crates/tor-netdir/Cargo.toml index 3094e4aab..ec80f0449 100644 --- a/crates/tor-netdir/Cargo.toml +++ b/crates/tor-netdir/Cargo.toml @@ -12,6 +12,11 @@ repository="https://gitlab.torproject.org/tpo/core/arti.git/" [features] default = [] + +# Enable experimental APIs that are not yet officially supported. +# +# These APIs are not covered by semantic versioning. Using this +# feature voids your "semver warrantee". experimental-api = [] # Enable testing-only APIs. APIs under this feature are not