zebrad: Add reference to config docs.
This commit is contained in:
parent
b8f174ee3a
commit
4b8f07ebb2
|
|
@ -27,8 +27,9 @@ impl Runnable for GenerateCmd {
|
||||||
# values may change, you should delete all entries except
|
# values may change, you should delete all entries except
|
||||||
# for the ones you wish to change.
|
# for the ones you wish to change.
|
||||||
#
|
#
|
||||||
# Documentation on the meanings of each config option
|
# Documentation on the meanings of each config field
|
||||||
# can be found in Rustdoc. XXX add link to rendered docs.
|
# 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
|
.to_owned(); // The default name and location of the config file is defined in ../commands.rs
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,11 @@ use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use zebra_network::Config as NetworkSection;
|
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)]
|
#[derive(Clone, Default, Debug, Deserialize, Serialize)]
|
||||||
#[serde(deny_unknown_fields)]
|
#[serde(deny_unknown_fields)]
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue