diff options
| author | Nick Mathewson <nickm@torproject.org> | 2022-02-28 14:25:24 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2022-02-28 14:25:24 -0500 |
| commit | dd8cd0869178699d513cb4a384795f8cb544f16d (patch) | |
| tree | 48c09c680193990997688416c9d75c00710bc10d | |
| parent | 49a219bc4bf688d8eae34b46a816265d523f7da9 (diff) | |
| download | arti-dd8cd0869178699d513cb4a384795f8cb544f16d.tar.gz arti-dd8cd0869178699d513cb4a384795f8cb544f16d.zip | |
Add warnings about configuration stability.
| -rw-r--r-- | crates/arti-client/src/config.rs | 10 | ||||
| -rw-r--r-- | crates/arti-config/src/lib.rs | 8 | ||||
| -rw-r--r-- | crates/tor-config/src/lib.rs | 8 |
3 files changed, 24 insertions, 2 deletions
diff --git a/crates/arti-client/src/config.rs b/crates/arti-client/src/config.rs index 1f3bf7862..9344773bc 100644 --- a/crates/arti-client/src/config.rs +++ b/crates/arti-client/src/config.rs @@ -282,8 +282,14 @@ impl From<SystemConfig> for SystemConfigBuilder { /// Finally, you can get fine-grained control over the members of a a /// TorClientConfig using [`TorClientConfigBuilder`]. /// -/// NOTE: These are NOT the final options or their final layout. -/// Expect NO stability here. +/// # ⚠ Stability Warning ⚠ +/// +/// The design of this structure, and of the configuration system for +/// Arti, is likely to change significantly before the release of Arti +/// 1.0.0. The layout of options within this structure is also likely +/// to change. For more information see ticket [#285]. +/// +/// [#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285 #[derive(Clone, Debug, Eq, PartialEq)] pub struct TorClientConfig { /// Information about the Tor network we want to connect to. diff --git a/crates/arti-config/src/lib.rs b/crates/arti-config/src/lib.rs index 07b5a89cf..829546ddc 100644 --- a/crates/arti-config/src/lib.rs +++ b/crates/arti-config/src/lib.rs @@ -8,6 +8,14 @@ //! //! It provides a client configuration tool using using `serde` and `config`, //! plus extra features defined here for convenience. +//! +//! # ⚠ Stability Warning ⚠ +//! +//! The design of this crate, and of the configuration system for +//! Arti, is likely to change significantly before the release of Arti +//! 1.0.0. For more information see ticket [#285]. +//! +//! [#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285 #![deny(missing_docs)] #![warn(noop_method_call)] diff --git a/crates/tor-config/src/lib.rs b/crates/tor-config/src/lib.rs index cbb2f6d1d..056502059 100644 --- a/crates/tor-config/src/lib.rs +++ b/crates/tor-config/src/lib.rs @@ -7,6 +7,14 @@ //! implement [Tor](https://www.torproject.org/) in Rust. //! //! It provides low-level types for handling configuration values. +//! +//! # ⚠ Stability Warning ⚠ +//! +//! The design of this crate, and of the configuration system for +//! Arti, is likely to change significantly before the release of Arti +//! 1.0.0. For more information see ticket [#285]. +//! +//! [#285]: https://gitlab.torproject.org/tpo/core/arti/-/issues/285 #![deny(missing_docs)] #![warn(noop_method_call)] |