From 730be38867c82b8d5ca76a569e1b1175ddf75cd4 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 21 Oct 2021 14:19:34 -0400 Subject: [PATCH] Replace references to arti-client in the documentation. --- crates/tor-circmgr/src/config.rs | 2 +- crates/tor-circmgr/src/lib.rs | 2 +- crates/tor-circmgr/src/usage.rs | 4 ++-- crates/tor-dirmgr/src/config.rs | 4 ++-- crates/tor-netdir/src/fallback.rs | 2 +- crates/tor-proto/src/lib.rs | 4 ++-- crates/tor-proto/src/stream/data.rs | 2 +- crates/tor-protover/src/lib.rs | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/crates/tor-circmgr/src/config.rs b/crates/tor-circmgr/src/config.rs index 1f170d641..c719e3afd 100644 --- a/crates/tor-circmgr/src/config.rs +++ b/crates/tor-circmgr/src/config.rs @@ -2,7 +2,7 @@ //! //! # Semver note //! -//! Most types in this module are re-exported by `tor-client`. +//! Most types in this module are re-exported by `arti-client`. use derive_builder::Builder; use serde::Deserialize; diff --git a/crates/tor-circmgr/src/lib.rs b/crates/tor-circmgr/src/lib.rs index 5f3904f47..42474e3b6 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-tor-client` crate, based on timings from the network + /// `arti-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-circmgr/src/usage.rs b/crates/tor-circmgr/src/usage.rs index be80be40a..4897ac9f6 100644 --- a/crates/tor-circmgr/src/usage.rs +++ b/crates/tor-circmgr/src/usage.rs @@ -68,8 +68,8 @@ impl TargetPort { /// /// # Semver note /// -/// This type is re-exported by `tor-client`: any changes to it must be -/// reflected in `tor-client`'s version. +/// This type is re-exported by `arti-client`: any changes to it must be +/// reflected in `arti-client`'s version. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub struct IsolationToken(u64); diff --git a/crates/tor-dirmgr/src/config.rs b/crates/tor-dirmgr/src/config.rs index 6a24ed64f..9d2a2b5d3 100644 --- a/crates/tor-dirmgr/src/config.rs +++ b/crates/tor-dirmgr/src/config.rs @@ -5,8 +5,8 @@ //! //! # Semver note //! -//! The types in this module are re-exported from `tor-client`: any changes -//! here must be reflected in the version of `tor-client`. +//! The types in this module are re-exported from `arti-client`: any changes +//! here must be reflected in the version of `arti-client`. use crate::retry::RetryConfig; use crate::storage::sqlite::SqliteStore; diff --git a/crates/tor-netdir/src/fallback.rs b/crates/tor-netdir/src/fallback.rs index 7c309e513..dc8f75142 100644 --- a/crates/tor-netdir/src/fallback.rs +++ b/crates/tor-netdir/src/fallback.rs @@ -7,7 +7,7 @@ //! //! # Semver note //! -//! The types in this module are re-exported from `tor-client` and +//! The types in this module are re-exported from `arti-client` and //! `tor-dirmgr`: any changes here must be reflected there. use derive_builder::Builder; diff --git a/crates/tor-proto/src/lib.rs b/crates/tor-proto/src/lib.rs index 02f9ccfe7..fe260d92e 100644 --- a/crates/tor-proto/src/lib.rs +++ b/crates/tor-proto/src/lib.rs @@ -9,7 +9,7 @@ //! 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. //! @@ -48,7 +48,7 @@ //! [`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-proto/src/stream/data.rs b/crates/tor-proto/src/stream/data.rs index a96472dd7..9a61d47a3 100644 --- a/crates/tor-proto/src/stream/data.rs +++ b/crates/tor-proto/src/stream/data.rs @@ -37,7 +37,7 @@ use tor_cell::relaycell::msg::{Data, RelayMsg}; /// # Semver note: /// /// Note that this type is re-exported as a part of the public API of -/// the `tor-client` crate. Any changes to its API here in +/// the `arti-client` crate. Any changes to its API here in /// `tor-proto` need to be reflected above. pub struct DataStream { /// Underlying writer for this stream diff --git a/crates/tor-protover/src/lib.rs b/crates/tor-protover/src/lib.rs index 65aa73391..e77cc11ac 100644 --- a/crates/tor-protover/src/lib.rs +++ b/crates/tor-protover/src/lib.rs @@ -30,7 +30,7 @@ //! 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.) #![deny(missing_docs)]