Browse Source

docs: add flag documentation (#4219)

pull/4221/head
Jonathan Gimeno 5 years ago
committed by Tess Rinearson
parent
commit
06b8752a46
2 changed files with 10 additions and 3 deletions
  1. +1
    -0
      CHANGELOG_PENDING.md
  2. +9
    -3
      docs/tendermint-core/using-tendermint.md

+ 1
- 0
CHANGELOG_PENDING.md View File

@ -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:


+ 9
- 3
docs/tendermint-core/using-tendermint.md View File

@ -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


Loading…
Cancel
Save