From 4b8f07ebb25bd789209d73c9a0c88b4eba2f0b88 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Wed, 17 Jun 2020 14:44:24 -0700 Subject: [PATCH] zebrad: Add reference to config docs. --- zebrad/src/commands/generate.rs | 5 +++-- zebrad/src/config.rs | 6 +++++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/zebrad/src/commands/generate.rs b/zebrad/src/commands/generate.rs index e4631612..0dcacf31 100644 --- a/zebrad/src/commands/generate.rs +++ b/zebrad/src/commands/generate.rs @@ -27,8 +27,9 @@ impl Runnable for GenerateCmd { # values may change, you should delete all entries except # for the ones you wish to change. # -# Documentation on the meanings of each config option -# can be found in Rustdoc. XXX add link to rendered docs. +# Documentation on the meanings of each config field +# can be found in Rustdoc here: +# https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html " .to_owned(); // The default name and location of the config file is defined in ../commands.rs diff --git a/zebrad/src/config.rs b/zebrad/src/config.rs index 0ddc0138..5fb2af7e 100644 --- a/zebrad/src/config.rs +++ b/zebrad/src/config.rs @@ -10,7 +10,11 @@ use serde::{Deserialize, Serialize}; use zebra_network::Config as NetworkSection; -/// Zebrad Configuration +/// Configuration for `zebrad`. +/// +/// The `zebrad` config is a TOML-encoded version of this structure. The meaning +/// of each field is described in the documentation, although it may be necessary +/// to click through to the sub-structures for each section. #[derive(Clone, Default, Debug, Deserialize, Serialize)] #[serde(deny_unknown_fields)] #[serde(default)]