Skip to content

Commit ad8a6be

Browse files
committed
add more intra-doc links
1 parent e8cca43 commit ad8a6be

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

stackslib/src/config/mod.rs

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1664,7 +1664,7 @@ pub struct NodeConfig {
16641664
/// The node's Bitcoin wallet private key, provided as a hex string in the config file.
16651665
/// Used to initialize the node's keychain for signing operations.
16661666
/// If `miner.mining_key` is not set, this seed may also be used for mining-related signing.
1667-
/// Required if the node is configured as a miner (`node.miner = true`) and `miner.mining_key` is absent.
1667+
/// Required if [`NodeConfig::miner`] is `true` and [`MinerConfig::mining_key`] is absent.
16681668
///
16691669
/// Default: Randomly generated 32 bytes.
16701670
pub seed: Vec<u8>,
@@ -1700,7 +1700,7 @@ pub struct NodeConfig {
17001700
pub p2p_address: String,
17011701
/// The private key seed, provided as a hex string in the config file, used specifically for the
17021702
/// node's identity and message signing within the P2P networking layer.
1703-
/// This is separate from the main `node.seed`.
1703+
/// This is separate from the main [`NodeConfig::seed`].
17041704
///
17051705
/// Default: Randomly generated 32 bytes.
17061706
pub local_peer_seed: Vec<u8>,
@@ -1721,8 +1721,8 @@ pub struct NodeConfig {
17211721
/// Default: Empty vector `[]`.
17221722
pub deny_nodes: Vec<Neighbor>,
17231723
/// Flag indicating whether this node should activate its mining logic and attempt to produce Stacks blocks.
1724-
/// Setting this to `true` typically requires providing necessary private keys (either `node.seed` or `miner.mining_key`).
1725-
/// It also influences default behavior for settings like `require_affirmed_anchor_blocks`.
1724+
/// Setting this to `true` typically requires providing necessary private keys (either [`NodeConfig::seed`] or [`MinerConfig::mining_key`]).
1725+
/// It also influences default behavior for settings like [`NodeConfig::require_affirmed_anchor_blocks`].
17261726
///
17271727
/// Default: `false`
17281728
pub miner: bool,
@@ -1732,12 +1732,14 @@ pub struct NodeConfig {
17321732
/// Default: `false`
17331733
pub stacker: bool,
17341734
/// Enables a simulated mining mode, primarily for local testing and development.
1735-
/// When `true`, *and* [`NodeConfig::miner`] is also `true`, the node may generate blocks
1736-
/// locally without participating in the real bitcoin consensus or P2P block production process.
1735+
/// When `true`, the node may generate blocks locally without participating in the
1736+
/// real bitcoin consensus or P2P block production process.
1737+
///
1738+
/// Only relevant if [`NodeConfig::miner`] is `true`.
17371739
///
17381740
/// Default: `false`
17391741
pub mock_mining: bool,
1740-
/// If `mock_mining` is enabled, this specifies an optional directory path where the
1742+
/// If [`NodeConfig::mock_mining`] is enabled, this specifies an optional directory path where the
17411743
/// generated mock Stacks blocks will be saved. (pre-Nakamoto)
17421744
/// The path is canonicalized on load.
17431745
///
@@ -1749,8 +1751,8 @@ pub struct NodeConfig {
17491751
/// Default: `true`
17501752
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
17511753
pub mine_microblocks: bool,
1752-
/// How often to attempt producing microblocks, in milliseconds (pre-Nakamoto).
1753-
/// Only applies when `mine_microblocks` is true and before Epoch 3.0.
1754+
/// How often to attempt producing microblocks, in milliseconds.
1755+
/// Only applies when [`NodeConfig::mine_microblocks`] is true and before Epoch 2.5.
17541756
///
17551757
/// Default: `30_000`
17561758
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
@@ -1760,8 +1762,8 @@ pub struct NodeConfig {
17601762
/// Default: `65535` (u16::MAX)
17611763
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
17621764
pub max_microblocks: u64,
1763-
/// Cooldown period after a microblock is produced, in milliseconds (pre-Nakamoto).
1764-
/// Only applies when `mine_microblocks` is true and before Epoch 3.0.
1765+
/// Cooldown period after a microblock is produced, in milliseconds.
1766+
/// Only applies when [`NodeConfig::mine_microblocks`] is true and before Epoch 2.5.
17651767
///
17661768
/// Default: `30_000`
17671769
/// Deprecated: Microblocks were removed in the Nakamoto upgrade. This setting is ignored in Epoch 3.0+.
@@ -1865,12 +1867,12 @@ pub struct NodeConfig {
18651867
/// This thread periodically wakes up the main coordinator to check for chain progress or
18661868
/// other conditions requiring action.
18671869
///
1868-
/// Default: `300` (5 minutes)
1870+
/// Default: `300` seconds (5 minutes)
18691871
pub chain_liveness_poll_time_secs: u64,
18701872
/// A list of specific StackerDB contracts (identified by their qualified contract identifiers,
18711873
/// e.g., "SP000000000000000000002Q6VF78.pox-3") that this node should actively replicate.
18721874
///
1873-
/// Default: The initial list depends on the `node.miner` and `node.stacker` settings:
1875+
/// Default: The initial list depends on the [`NodeConfig::miner`] and [`NodeConfig::stacker`] settings:
18741876
/// - If `miner = true` or `stacker = true`: Relevant system contracts (like `.miners`
18751877
/// and `.signers-*`) are automatically added during configuration loading, in addition
18761878
/// to any contracts specified in the configuration file.

0 commit comments

Comments
 (0)