chanmgr: Make "pt-client" non-experimental.

This commit is contained in:
Nick Mathewson 2022-11-16 12:30:08 -05:00
parent cf152c5ed6
commit b5a9e0b475
2 changed files with 9 additions and 4 deletions

View File

@ -13,7 +13,9 @@ repository = "https://gitlab.torproject.org/tpo/core/arti.git/"
[features]
default = []
experimental = ["pt-client"]
experimental = []
full = ["pt-client"]
pt-client = ["tor-linkspec/pt-client"]
testing = []

View File

@ -16,18 +16,21 @@ Since a channel can be used for more than one circuit, it's
important to reuse channels when possible. This crate implements
a [`ChanMgr`] type that can be used to create channels on demand,
and return existing channels when they already exist.
## Compile-time features
* `pt-client` -- Build with APIs to support
pluggable transports.
### Experimental and unstable features
Note that the APIs enabled by these features are NOT covered by
semantic versioning[^1] guarantees: we might break them or remove
them between patch versions.
* `pt-client` -- Build with (as yet unimplemented) APIs to support
pluggable transports.
* `experimental` -- Build with all experimental features above.
(Currently, there are no experimental features in this crate,
but there may be some in the future.)
[^1]: Remember, semantic versioning is what makes various `cargo`
features work reliably. To be explicit: if you want `cargo update`