From 06b8752a468c407faabb9c217773d011acb6452a Mon Sep 17 00:00:00 2001 From: Jonathan Gimeno Date: Wed, 4 Dec 2019 18:48:26 +0100 Subject: [PATCH] docs: add flag documentation (#4219) --- CHANGELOG_PENDING.md | 1 + docs/tendermint-core/using-tendermint.md | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG_PENDING.md b/CHANGELOG_PENDING.md index 4324412aa..6e8beed4b 100644 --- a/CHANGELOG_PENDING.md +++ b/CHANGELOG_PENDING.md @@ -97,6 +97,7 @@ program](https://hackerone.com/tendermint). - [docs] [\#4111](https://github.com/tendermint/tendermint/issues/4111) Replaced dead whitepaper link in README.md - [p2p] [\#4185](https://github.com/tendermint/tendermint/pull/4185) Simplify `SecretConnection` handshake with merlin - [cli] [\#4065](https://github.com/tendermint/tendermint/issues/4065) Add `--consensus.create_empty_blocks_interval` flag (@jgimeno) +- [docs] [\#4065](https://github.com/tendermint/tendermint/issues/4065) Document `--consensus.create_empty_blocks_interval` flag (@jgimeno) ### BUG FIXES: diff --git a/docs/tendermint-core/using-tendermint.md b/docs/tendermint-core/using-tendermint.md index 0c866af29..d424f7455 100644 --- a/docs/tendermint-core/using-tendermint.md +++ b/docs/tendermint-core/using-tendermint.md @@ -263,12 +263,18 @@ create_empty_blocks = false Remember: because the default is to _create empty blocks_, avoiding empty blocks requires the config option to be set to `false`. -The block interval setting allows for a delay (in seconds) between the -creation of each new empty block. It is set via the `config.toml`: +The block interval setting allows for a delay (in time.Duration format [ParseDuration](https://golang.org/pkg/time/#ParseDuration)) between the +creation of each new empty block. It can be set with this additional flag: + +``` +--consensus.create_empty_blocks_interval="5s" +``` + +or set the configuration via the `config.toml` file: ``` [consensus] -create_empty_blocks_interval = 5 +create_empty_blocks_interval = "5s" ``` With this setting, empty blocks will be produced every 5s if no block