From b477f12d83f0e2ea50819f31748e8756110d6718 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Mon, 25 Oct 2021 08:40:00 -0400 Subject: [PATCH] s/arti-arti-client/arti-client/ and regenerate readme files --- crates/arti-client/README.md | 2 +- crates/arti-client/src/lib.rs | 2 +- crates/tor-circmgr/src/lib.rs | 2 +- crates/tor-proto/README.md | 4 ++-- crates/tor-protover/README.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/crates/arti-client/README.md b/crates/arti-client/README.md index 19eba8eb9..8fb0c91d6 100644 --- a/crates/arti-client/README.md +++ b/crates/arti-client/README.md @@ -4,7 +4,7 @@ High-level functionality for accessing the Tor network as a client. ## Overview -The `arti-arti-client` crate aims to provide a safe, easy-to-use API for +The `arti-client` crate aims to provide a safe, easy-to-use API for applications that want to use Tor network to anonymize their traffic. It hides most of the underlying detail, letting other crates decide how exactly to use the Tor crate. diff --git a/crates/arti-client/src/lib.rs b/crates/arti-client/src/lib.rs index 35ddb6d2f..1fe52a83c 100644 --- a/crates/arti-client/src/lib.rs +++ b/crates/arti-client/src/lib.rs @@ -2,7 +2,7 @@ //! //! # Overview //! -//! The `arti-arti-client` crate aims to provide a safe, easy-to-use API for +//! The `arti-client` crate aims to provide a safe, easy-to-use API for //! applications that want to use Tor network to anonymize their //! traffic. It hides most of the underlying detail, letting other //! crates decide how exactly to use the Tor crate. diff --git a/crates/tor-circmgr/src/lib.rs b/crates/tor-circmgr/src/lib.rs index 42474e3b6..1e42542a6 100644 --- a/crates/tor-circmgr/src/lib.rs +++ b/crates/tor-circmgr/src/lib.rs @@ -288,7 +288,7 @@ impl CircMgr { /// # Note /// /// This function is invoked periodically from the - /// `arti-arti-client` crate, based on timings from the network + /// `arti-client` crate, based on timings from the network /// parameters. Please don't invoke it on your own; I hope we can /// have this API go away in the future. /// diff --git a/crates/tor-proto/README.md b/crates/tor-proto/README.md index 232cd0ca1..8546aae6c 100644 --- a/crates/tor-proto/README.md +++ b/crates/tor-proto/README.md @@ -11,7 +11,7 @@ Most people shouldn't use this crate directly, since its APIs are needlessly low-level for most purposes, and it is easy to misuse them in an insecure or privacy-violating way. -Most people should use the [`tor-client`] crate instead. This crate is +Most people should use the [`arti-client`] crate instead. This crate is of interest mainly for those that want to access the Tor protocols at a low level. @@ -50,7 +50,7 @@ about some Tor relays, and expose their information via [`tor_linkspec::ChanTarget`] and [`tor_linkspec::CircTarget`]. Currently, the [`tor-netdir`] crate is the easiest way to do so. -For an example of this crate in action, see the [`tor-client`] +For an example of this crate in action, see the [`arti-client`] library, or the `arti` CLI. ## Design notes diff --git a/crates/tor-protover/README.md b/crates/tor-protover/README.md index 9c4d8a8a7..b9485310e 100644 --- a/crates/tor-protover/README.md +++ b/crates/tor-protover/README.md @@ -32,7 +32,7 @@ themselves depend on one another. (For example, [`tor-proto`] needs to know which variant of a subprotocol can be used with a given relay, whereas [`tor-netdoc`] needs to parse lists of subprotocol versions from directory documents. Eventually, -[`tor-client`] will need to check its own list of supported +[`arti-client`] will need to check its own list of supported protocols against the required list in the consensus.) License: MIT OR Apache-2.0