From 9f661e264f8e39117a997bca5f97ba044faac4f8 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Wed, 16 Nov 2022 12:55:03 -0500 Subject: [PATCH] dirmgr: make "bridge-client" non-experimental. --- crates/tor-dirmgr/Cargo.toml | 4 ++-- crates/tor-dirmgr/README.md | 24 ++++++++++++++---------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/crates/tor-dirmgr/Cargo.toml b/crates/tor-dirmgr/Cargo.toml index 5f780d4e7..6d54aad01 100644 --- a/crates/tor-dirmgr/Cargo.toml +++ b/crates/tor-dirmgr/Cargo.toml @@ -13,8 +13,8 @@ repository = "https://gitlab.torproject.org/tpo/core/arti.git/" [features] default = ["mmap", "compression"] -full = ["routerdesc"] -experimental = ["experimental-api", "dirfilter", "bridge-client"] +full = ["routerdesc", "bridge-client", "default"] +experimental = ["experimental-api", "dirfilter"] bridge-client = ["tor-circmgr/specific-relay", "tor-guardmgr/bridge-client", "routerdesc"] mmap = ["memmap2"] diff --git a/crates/tor-dirmgr/README.md b/crates/tor-dirmgr/README.md index c52d52896..0fa19c9e4 100644 --- a/crates/tor-dirmgr/README.md +++ b/crates/tor-dirmgr/README.md @@ -18,16 +18,23 @@ keeping a cache of it on disk. ## Compile-time features -`mmap` (default) -- Use memory mapping to reduce the memory load for -reading large directory objects from disk. +* `mmap` (default) -- Use memory mapping to reduce the memory load for + reading large directory objects from disk. -`static` -- Try to link with a static copy of sqlite3. +* `routerdesc` -- (Incomplete) support for downloading and storing + router descriptors. -`routerdesc` -- (Incomplete) support for downloading and storing - router descriptors. +* `compression` (default) -- Build support for downloading compressed + documents. Requires a C compiler. -`compression` (default) -- Build support for downloading compressed -documents. Requires a C compiler. +* `bridge-client`: Provide APIs used to fetch + and use bridge information. + +* `full` -- Enable all features above. + +### Non-additive features + +* `static` -- Try to link with a static copy of sqlite3. ### Experimental and unstable features @@ -41,9 +48,6 @@ them between patch versions. * `dirfilter`: enable an experimental mechanism to modify incoming directory information before it is used. -* `bridge-client`: Provide (as yet unimplented) APIs used to fetch - and use bridge information. - * `experimental`: Enable all the above experimental features. [^1]: Remember, semantic versioning is what makes various `cargo`