Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix quotation mark #1577

Merged
merged 1 commit into from
Jan 18, 2025
Merged

docs: fix quotation mark #1577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,11 +976,11 @@ type ConsensusConfig struct {
TimeoutPropose time.Duration `mapstructure:"timeout_propose"`
// How much timeout_propose increases with each round
TimeoutProposeDelta time.Duration `mapstructure:"timeout_propose_delta"`
// How long we wait after receiving +2/3 prevotes for “anything” (ie. not a single block or nil)
// How long we wait after receiving +2/3 prevotes for "anything" (ie. not a single block or nil)
TimeoutPrevote time.Duration `mapstructure:"timeout_prevote"`
// How much the timeout_prevote increases with each round
TimeoutPrevoteDelta time.Duration `mapstructure:"timeout_prevote_delta"`
// How long we wait after receiving +2/3 precommits for “anything” (ie. not a single block or nil)
// How long we wait after receiving +2/3 precommits for "anything" (ie. not a single block or nil)
TimeoutPrecommit time.Duration `mapstructure:"timeout_precommit"`
// How much the timeout_precommit increases with each round
TimeoutPrecommitDelta time.Duration `mapstructure:"timeout_precommit_delta"`
Expand Down
4 changes: 2 additions & 2 deletions config/toml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,11 +485,11 @@ wal_file = "{{ js .Consensus.WalPath }}"
timeout_propose = "{{ .Consensus.TimeoutPropose }}"
# How much timeout_propose increases with each round
timeout_propose_delta = "{{ .Consensus.TimeoutProposeDelta }}"
# How long we wait after receiving +2/3 prevotes for “anything” (ie. not a single block or nil)
# How long we wait after receiving +2/3 prevotes for "anything" (ie. not a single block or nil)
timeout_prevote = "{{ .Consensus.TimeoutPrevote }}"
# How much the timeout_prevote increases with each round
timeout_prevote_delta = "{{ .Consensus.TimeoutPrevoteDelta }}"
# How long we wait after receiving +2/3 precommits for “anything” (ie. not a single block or nil)
# How long we wait after receiving +2/3 precommits for "anything" (ie. not a single block or nil)
timeout_precommit = "{{ .Consensus.TimeoutPrecommit }}"
# How much the timeout_precommit increases with each round
timeout_precommit_delta = "{{ .Consensus.TimeoutPrecommitDelta }}"
Expand Down
2 changes: 1 addition & 1 deletion spec/consensus/proposer-selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ order: 3
# Proposer Selection Procedure

This document specifies the Proposer Selection Procedure that is used in Tendermint, the consensus algorithm adopted in CometBFT, to choose a round proposer.
As Tendermint is “leader-based consensus protocol”, the proposer selection is critical for its correct functioning.
As Tendermint is "leader-based consensus protocol", the proposer selection is critical for its correct functioning.

At a given block height, the proposer selection algorithm runs with the same validator set at each round .
Between heights, an updated validator set may be specified by the application as part of the ABCIResponses' EndBlock.
Expand Down
2 changes: 1 addition & 1 deletion spec/light-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ version 001. The TLA+ properties can be found in the
[TLA+ specification](verification/Lightclient_A_1.tla).
The experiments were run in an AWS instance equipped with 32GB
RAM and a 4-core Intel® Xeon® CPU E5-2686 v4 @ 2.30GHz CPU.
We write “✗=k” when a bug is reported at depth k, and “✓<=k” when
We write "✗=k" when a bug is reported at depth k, and "✓<=k" when
no bug is reported up to depth k.

![Experimental results](experiments.png)
Expand Down
8 changes: 4 additions & 4 deletions spec/p2p/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ and upon incoming connection shares some peers and disconnects.

## Seeds

`--p2p.seeds “[email protected]:26656,[email protected]:4444”`
`--p2p.seeds "[email protected]:26656,[email protected]:4444"`

Dials these seeds when we need more peers. They should return a list of peers and then disconnect.
If we already have enough peers in the address book, we may never need to dial them.

## Persistent Peers

`--p2p.persistent_peers “[email protected]:26656,[email protected]:26656”`
`--p2p.persistent_peers "[email protected]:26656,[email protected]:26656"`

Dial these peers and auto-redial them if the connection fails.
These are intended to be trusted persistent peers that can help
Expand All @@ -36,14 +36,14 @@ and that the node may not be able to keep the connection persistent.

## Private Peers

`--p2p.private_peer_ids “id100000000000000000000000000000000,id200000000000000000000000000000000”`
`--p2p.private_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"`

These are IDs of the peers that we do not add to the address book or gossip to
other peers. They stay private to us.

## Unconditional Peers

`--p2p.unconditional_peer_ids “id100000000000000000000000000000000,id200000000000000000000000000000000”`
`--p2p.unconditional_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"`

These are IDs of the peers which are allowed to be connected by both inbound or outbound regardless of
`max_num_inbound_peers` or `max_num_outbound_peers` of user's node reached or not.
8 changes: 4 additions & 4 deletions spec/p2p/v0.34/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ These parameters can be set using the `$CMTHOME/config/config.toml` file. A subs
| Parameter | Flag| Example|
| --- | --- | ---|
| Listen address| `p2p.laddr` | "tcp://0.0.0.0:26656" |
| Seed nodes | `p2p.seeds` | `--p2p.seeds “[email protected]:26656,[email protected]:4444”` |
| Persistent peers | `p2p.persistent_peers` | `--p2p.persistent_peers “[email protected]:26656,[email protected]:26656”` |
| Unconditional peers | `p2p.unconditional_peer_ids` | `--p2p.unconditional_peer_ids “id100000000000000000000000000000000,id200000000000000000000000000000000”` |
| Seed nodes | `p2p.seeds` | `--p2p.seeds "[email protected]:26656,[email protected]:4444"` |
| Persistent peers | `p2p.persistent_peers` | `--p2p.persistent_peers "[email protected]:26656,[email protected]:26656"` |
| Unconditional peers | `p2p.unconditional_peer_ids` | `--p2p.unconditional_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"` |
| UPNP | `p2p.upnp` | `--p2p.upnp` |
| PexReactor | `p2p.pex` | `--p2p.pex` |
| Seed mode | `p2p.seed_mode` | `--p2p.seed_mode` |
| Private peer ids | `p2p.private_peer_ids` | `--p2p.private_peer_ids “id100000000000000000000000000000000,id200000000000000000000000000000000”` |
| Private peer ids | `p2p.private_peer_ids` | `--p2p.private_peer_ids "id100000000000000000000000000000000,id200000000000000000000000000000000"` |

**Note on persistent peers**

Expand Down
Loading