Merge pull request #1390 from bigchaindb/remove-consensus-plugin-docs

Made the consensus plugin an undocumented feature
This commit is contained in:
Troy McConaghy 2017-04-13 10:43:31 +02:00 committed by GitHub
commit 5afc63ac67
3 changed files with 1 additions and 20 deletions

View File

@ -1,5 +0,0 @@
#########
Consensus
#########
.. automodule:: bigchaindb.consensus

View File

@ -13,7 +13,6 @@ Appendices
json-serialization json-serialization
cryptography cryptography
the-Bigchain-class the-Bigchain-class
consensus
pipelines pipelines
backend backend
commands commands

View File

@ -21,7 +21,6 @@ For convenience, here's a list of all the relevant environment variables (docume
`BIGCHAINDB_SERVER_THREADS`<br> `BIGCHAINDB_SERVER_THREADS`<br>
`BIGCHAINDB_CONFIG_PATH`<br> `BIGCHAINDB_CONFIG_PATH`<br>
`BIGCHAINDB_BACKLOG_REASSIGN_DELAY`<br> `BIGCHAINDB_BACKLOG_REASSIGN_DELAY`<br>
`BIGCHAINDB_CONSENSUS_PLUGIN`<br>
`BIGCHAINDB_LOG`<br> `BIGCHAINDB_LOG`<br>
`BIGCHAINDB_LOG_FILE`<br> `BIGCHAINDB_LOG_FILE`<br>
`BIGCHAINDB_LOG_LEVEL_CONSOLE`<br> `BIGCHAINDB_LOG_LEVEL_CONSOLE`<br>
@ -169,21 +168,9 @@ export BIGCHAINDB_BACKLOG_REASSIGN_DELAY=30
"backlog_reassign_delay": 120 "backlog_reassign_delay": 120
``` ```
## consensus_plugin
The [consensus plugin](../appendices/consensus.html) to use.
**Example using an environment variable**
```text
export BIGCHAINDB_CONSENSUS_PLUGIN=default
```
**Example config file snippet: the default**
```js
"consensus_plugin": "default"
```
## log ## log
The `log` key is expected to point to a mapping (set of key/value pairs) The `log` key is expected to point to a mapping (set of key/value pairs)
holding the logging configuration. holding the logging configuration.