diff --git a/.gitignore b/.gitignore index cc6e1d67..23ae616e 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,5 @@ test/p2p/data/ test/logs .glide coverage.txt +docs/_build +docs/tools diff --git a/docs/how-to-read-logs.rst b/docs/how-to-read-logs.rst index 275b2c0b..890057a2 100644 --- a/docs/how-to-read-logs.rst +++ b/docs/how-to-read-logs.rst @@ -62,12 +62,12 @@ Next we replay all the messages from the WAL. I[10-04|13:54:30.392] Started node module=main nodeInfo="NodeInfo{pk: PubKeyEd25519{DF22D7C92C91082324A1312F092AA1DA197FA598DBBFB6526E177003C4D6FD66}, moniker: anonymous, network: test-chain-3MNw2N [remote , listen 10.0.2.15:46656], version: 0.11.0-10f361fc ([wire_version=0.6.2 p2p_version=0.5.0 consensus_version=v1/0.2.2 rpc_version=0.7.0/3 tx_index=on rpc_addr=tcp://0.0.0.0:46657])}" Next follows a standard block creation cycle, where we enter a new round, -propose a block, receive more than 2/3 of prevotes, than precommits and finally +propose a block, receive more than 2/3 of prevotes, then precommits and finally have a chance to commit a block. For details, please refer to `Consensus Overview -__` +`__ or `Byzantine Consensus Algorithm -__`. +`__. :: @@ -117,11 +117,11 @@ Here is the list of modules you may encounter in Tendermint's log and a little overview what they do. - ``abci-client`` As mentioned in `Application Development Guide - __`, + `__, Tendermint acts as an ABCI client with respect to the application and maintains 3 connections: mempool, consensus and query. The code used by Tendermint Core can be found `here - __`. + `__. - ``blockchain`` Provides storage, pool (a group of peers), and reactor for both storing and @@ -136,10 +136,10 @@ overview what they do. - ``events`` Simple event notification system. The list of events can be found `here - __`. + `__. You can subscribe to them by calling ``subscribe`` RPC method. Refer to `RPC docs - __` + `__ for additional information. - ``mempool`` @@ -149,13 +149,13 @@ overview what they do. - ``p2p`` Provides an abstraction around peer-to-peer communication. For more details, please check out the `README - __`. + `__. - ``rpc`` - `Tendermint's RPC __`. + `Tendermint's RPC `__. - ``rpc-server`` - RPC server. For implementation details, please read the `README __` . + RPC server. For implementation details, please read the `README `__. - ``state`` Represents the latest state and execution submodule, which executes