chore(book): document missing CLI arguments (#3610)

This commit is contained in:
Alexey Shekhirin
2023-07-06 13:08:29 +01:00
committed by GitHub
parent 93d66ab32f
commit d9dc9aac92
7 changed files with 212 additions and 30 deletions

View File

@ -50,6 +50,20 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs

View File

@ -135,6 +135,20 @@ Networking:
--port <PORT> --port <PORT>
Network listening port. default: 30303 Network listening port. default: 30303
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
--to <TO> --to <TO>
The maximum block height The maximum block height
@ -213,15 +227,29 @@ Options:
[default: mainnet] [default: mainnet]
-h, --help
Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
--to <TO> --to <TO>
The height to finish at The height to finish at
--skip-node-depth <SKIP_NODE_DEPTH> --skip-node-depth <SKIP_NODE_DEPTH>
The depth after which we should start comparing branch nodes The depth after which we should start comparing branch nodes
-h, --help
Print help (see a summary with '-h')
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs

View File

@ -7,13 +7,6 @@ $ reth import --help
Usage: reth import [OPTIONS] <IMPORT_PATH> Usage: reth import [OPTIONS] <IMPORT_PATH>
Arguments:
<IMPORT_PATH>
The path to a block file for import.
The online stages (headers and bodies) are replaced by a file import, after which the
remaining stages are executed.
Options: Options:
--config <FILE> --config <FILE>
The path to the configuration file to use. The path to the configuration file to use.
@ -44,6 +37,26 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
<IMPORT_PATH>
The path to a block file for import.
The online stages (headers and bodies) are replaced by a file import, after which the
remaining stages are executed.
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs

View File

@ -34,6 +34,20 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs

View File

@ -167,12 +167,7 @@ RPC:
[default: 25] [default: 25]
--rpc.gascap <GAS_CAP> Gas Price Oracle:
Maximum gas limit for `eth_call` and call tracing RPC methods
[default: 30000000]
GAS PRICE ORACLE:
--gpo.blocks <BLOCKS> --gpo.blocks <BLOCKS>
Number of recent blocks to check for gas price Number of recent blocks to check for gas price
@ -193,20 +188,56 @@ GAS PRICE ORACLE:
[default: 60] [default: 60]
--block-cache-size <BLOCK_CACHE_SIZE> --block-cache-len <BLOCK_CACHE_LEN>
Max size for cached block data in megabytes Maximum number of block cache entries
[default: 500] [default: 5000]
--receipt-cache-size <RECEIPT_CACHE_SIZE> --receipt-cache-len <RECEIPT_CACHE_LEN>
Max size for cached receipt data in megabytes Maximum number of receipt cache entries
[default: 500] [default: 2000]
--env-cache-size <ENV_CACHE_SIZE> --env-cache-len <ENV_CACHE_LEN>
Max size for cached evm env data in megabytes Maximum number of env cache entries
[default: 1] [default: 1000]
TxPool:
--txpool.pending_max_count <PENDING_MAX_COUNT>
Max number of transaction in the pending sub-pool
[default: 10000]
--txpool.pending_max_size <PENDING_MAX_SIZE>
Max size of the pending sub-pool in megabytes
[default: 20]
--txpool.basefee_max_count <BASEFEE_MAX_COUNT>
Max number of transaction in the basefee sub-pool
[default: 10000]
--txpool.basefee_max_size <BASEFEE_MAX_SIZE>
Max size of the basefee sub-pool in megabytes
[default: 20]
--txpool.queued_max_count <QUEUED_MAX_COUNT>
Max number of transaction in the queued sub-pool
[default: 10000]
--txpool.queued_max_size <QUEUED_MAX_SIZE>
Max size of the queued sub-pool in megabytes
[default: 20]
--txpool.max_account_slots <MAX_ACCOUNT_SLOTS>
Max number of executable transaction slots guaranteed per account
[default: 16]
Builder: Builder:
--builder.extradata <EXTRADATA> --builder.extradata <EXTRADATA>
@ -263,7 +294,20 @@ Debug:
--debug.hook-all --debug.hook-all
Hook on every transaction in a block Hook on every transaction in a block
Rpc: Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
--auto-mine --auto-mine
Automatically mine blocks for new transactions Automatically mine blocks for new transactions

View File

@ -76,6 +76,20 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs

View File

@ -63,10 +63,6 @@ $ reth stage drop --help
Usage: reth stage drop [OPTIONS] <STAGE> Usage: reth stage drop [OPTIONS] <STAGE>
Arguments:
<STAGE>
[possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, history, account-history, storage-history, total-difficulty]
Options: Options:
--datadir <DATA_DIR> --datadir <DATA_DIR>
The path to the data dir for all reth files and subdirectories. The path to the data dir for all reth files and subdirectories.
@ -94,6 +90,23 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
<STAGE>
[possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, history, account-history, storage-history, total-difficulty]
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs
@ -173,6 +186,20 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs
@ -543,6 +570,20 @@ Networking:
--port <PORT> --port <PORT>
Network listening port. default: 30303 Network listening port. default: 30303
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
-c, --commit -c, --commit
Commits the changes in the database. WARNING: potentially destructive. Commits the changes in the database. WARNING: potentially destructive.
@ -623,6 +664,20 @@ Options:
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent --log.persistent
The flag to enable persistent logs The flag to enable persistent logs