Skip to content

Commit bc8389c

Browse files
fixup docs
1 parent 9feb3a4 commit bc8389c

File tree

2 files changed

+1
-19
lines changed

2 files changed

+1
-19
lines changed

iroh/src/node/builder.rs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,6 @@ pub const DEFAULT_BIND_ADDR_V6: SocketAddrV6 =
4747

4848
/// Builder for the [`Node`].
4949
///
50-
/// You must supply a blob store and a document store.
51-
///
52-
/// Blob store implementations are available in [`iroh_blobs::store`].
53-
///
54-
/// Everything else is optional, with some sensible defaults.
55-
///
5650
/// The default **relay servers** are hosted by [number 0] on the `iroh.network` domain. To
5751
/// customise this use the [`Builder::relay_mode`] function.
5852
///
@@ -121,7 +115,7 @@ pub enum DiscoveryConfig {
121115
/// cargo feature from [iroh-net] is enabled. In this case only the Pkarr/DNS service
122116
/// is used, but on the `iroh.test` domain. This domain is not integrated with the
123117
/// global DNS network and thus node discovery is effectively disabled. To use node
124-
/// discovery in a test use the [`iroh_net::test_utils::DnsPkarrServer`] in the test and
118+
/// discovery in a test use the `iroh_net::test_utils::DnsPkarrServer` in the test and
125119
/// configure it here as a custom discovery mechanism ([`DiscoveryConfig::Custom`]).
126120
///
127121
/// [number 0]: https://n0.computer

iroh/src/util/path.rs

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,12 @@ pub enum IrohPaths {
99
/// Path to the node's secret key for the [`iroh_net::key::PublicKey`].
1010
#[strum(serialize = "keypair")]
1111
SecretKey,
12-
/// Path to the node's [file based blob store](iroh_blobs::store::fs::Store).
13-
#[strum(serialize = "blobs")]
14-
BaoStoreDir,
15-
/// Path to the [iroh-docs document database](iroh_docs::store::fs::Store)
16-
#[strum(serialize = "docs.redb")]
17-
DocsDatabase,
18-
/// Path to the console state
19-
#[strum(serialize = "console")]
20-
Console,
2112
#[strum(serialize = "peers.postcard")]
2213
/// Path to store known peer data.
2314
PeerData,
2415
#[strum(serialize = "rpc.lock")]
2516
/// Path to RPC lock file, containing the RPC port if running.
2617
RpcLock,
27-
/// Path to the [`iroh_docs::AuthorId`] of the node's default author
28-
#[strum(serialize = "default-author")]
29-
DefaultAuthor,
3018
}
3119

3220
impl AsRef<Path> for IrohPaths {

0 commit comments

Comments
 (0)