mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-01-08 22:23:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: use hyphens instead of snake case (#5802)

Browse Source
This commit is contained in:
Callum Waters
2020-12-17 08:59:58 +01:00
committed by GitHub
parent 6ef81c6074
commit ebff8a96a5
29 changed files with 206 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tendermint-core/using-tendermint.md
View File

@@ -138,7 +138,7 @@ another window. If you don't, kill Tendermint and run an in-process version of
the `kvstore` app:
```bash
tendermint node --proxy_app=kvstore
tendermint node --proxy-app=kvstore
```
After a few seconds, you should see blocks start streaming in. Note that blocks
@@ -148,11 +148,11 @@ Blocks_, below, to modify this setting.
Tendermint supports in-process versions of the `counter`, `kvstore`, and `noop`
apps that ship as examples with `abci-cli`. It's easy to compile your app
in-process with Tendermint if it's written in Go. If your app is not written in
Go, run it in another process, and use the `--proxy_app` flag to specify the
Go, run it in another process, and use the `--proxy-app` flag to specify the
address of the socket it is listening on, for instance:
```bash
tendermint node --proxy_app=/var/run/abci.sock
tendermint node --proxy-app=/var/run/abci.sock
```
You can find out what flags are supported by running `tendermint node --help`.
@@ -254,7 +254,7 @@ Tendermint uses a `config.toml` for configuration. For details, see [the
config specification](./configuration.md).
Notable options include the socket address of the application
(`proxy_app`), the listening address of the Tendermint peer
(`proxy-app`), the listening address of the Tendermint peer
(`p2p.laddr`), and the listening address of the RPC server
(`rpc.laddr`).
@@ -441,7 +441,7 @@ have to use a seed node if you have a live persistent peer.
To connect to peers on start-up, specify them in the
`$TMHOME/config/config.toml` or on the command line. Use `seeds` to
specify seed nodes, and
`persistent_peers` to specify peers that your node will maintain
`persistent-peers` to specify peers that your node will maintain
persistent connections with.
For example,
@@ -462,12 +462,12 @@ should not need seeds after the first start.
If you want Tendermint to connect to specific set of addresses and
maintain a persistent connection with each, you can use the
`--p2p.persistent_peers` flag or the corresponding setting in the
`--p2p.persistent-peers` flag or the corresponding setting in the
`config.toml` or the `/dial_peers` RPC endpoint to do it without
stopping Tendermint core instance.
```sh
tendermint node --p2p.persistent_peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
tendermint node --p2p.persistent-peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
curl 'localhost:26657/dial_peers?persistent=true&peers=\["429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656","96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"\]'
```
@@ -546,7 +546,7 @@ file and the new `priv_validator_key.json` to the `~/.tendermint/config` on
a new machine.
Now run `tendermint node` on both machines, and use either
`--p2p.persistent_peers` or the `/dial_peers` to get them to peer up.
`--p2p.persistent-peers` or the `/dial_peers` to get them to peer up.
They should start making blocks, and will only continue to do so as long
as both of them are online.