From d421120a2513f7f5646a6c14bf993ae127c060c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Urbanek?= Date: Tue, 9 Jan 2024 18:14:55 +0100 Subject: [PATCH] Use text instead of bash for CLI docs (#5977) --- book/cli/reth/config.md | 2 +- book/cli/reth/db.md | 2 +- book/cli/reth/db/clear.md | 2 +- book/cli/reth/db/diff.md | 2 +- book/cli/reth/db/drop.md | 2 +- book/cli/reth/db/get.md | 2 +- book/cli/reth/db/list.md | 2 +- book/cli/reth/db/path.md | 2 +- book/cli/reth/db/snapshot.md | 2 +- book/cli/reth/db/stats.md | 2 +- book/cli/reth/db/version.md | 2 +- book/cli/reth/debug.md | 2 +- book/cli/reth/import.md | 2 +- book/cli/reth/init.md | 2 +- book/cli/reth/node.md | 2 +- book/cli/reth/p2p.md | 2 +- book/cli/reth/p2p/body.md | 2 +- book/cli/reth/p2p/header.md | 2 +- book/cli/reth/recover.md | 2 +- book/cli/reth/recover/storage-tries.md | 2 +- book/cli/reth/stage.md | 2 +- book/cli/reth/stage/drop.md | 2 +- book/cli/reth/stage/dump.md | 2 +- book/cli/reth/stage/dump/account-hashing.md | 2 +- book/cli/reth/stage/dump/execution.md | 2 +- book/cli/reth/stage/dump/merkle.md | 2 +- book/cli/reth/stage/dump/storage-hashing.md | 2 +- book/cli/reth/stage/run.md | 2 +- book/cli/reth/stage/unwind.md | 2 +- book/cli/reth/stage/unwind/num-blocks.md | 2 +- book/cli/reth/stage/unwind/to-block.md | 2 +- book/cli/reth/test-vectors.md | 2 +- book/cli/reth/test-vectors/tables.md | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/book/cli/reth/config.md b/book/cli/reth/config.md index bd1abe4fe9..30cc4715a5 100644 --- a/book/cli/reth/config.md +++ b/book/cli/reth/config.md @@ -2,7 +2,7 @@ Write config to stdout -```bash +```text $ reth config --help Usage: reth config [OPTIONS] diff --git a/book/cli/reth/db.md b/book/cli/reth/db.md index 0ef1ac526d..cac6fa04b1 100644 --- a/book/cli/reth/db.md +++ b/book/cli/reth/db.md @@ -2,7 +2,7 @@ Database debugging utilities -```bash +```text $ reth db --help Usage: reth db [OPTIONS] diff --git a/book/cli/reth/db/clear.md b/book/cli/reth/db/clear.md index 6015dc7517..ad1f999baf 100644 --- a/book/cli/reth/db/clear.md +++ b/book/cli/reth/db/clear.md @@ -2,7 +2,7 @@ Deletes all table entries -```bash +```text $ reth db clear --help Usage: reth db clear [OPTIONS] diff --git a/book/cli/reth/db/diff.md b/book/cli/reth/db/diff.md index 6c03b8a9b7..1ce2a14f32 100644 --- a/book/cli/reth/db/diff.md +++ b/book/cli/reth/db/diff.md @@ -2,7 +2,7 @@ Create a diff between two database tables or two entire databases -```bash +```text $ reth db diff --help Usage: reth db diff [OPTIONS] --secondary-datadir --output diff --git a/book/cli/reth/db/drop.md b/book/cli/reth/db/drop.md index ab87c4d746..9a8d64de0d 100644 --- a/book/cli/reth/db/drop.md +++ b/book/cli/reth/db/drop.md @@ -2,7 +2,7 @@ Deletes all database entries -```bash +```text $ reth db drop --help Usage: reth db drop [OPTIONS] diff --git a/book/cli/reth/db/get.md b/book/cli/reth/db/get.md index e35b60345c..4452490fd7 100644 --- a/book/cli/reth/db/get.md +++ b/book/cli/reth/db/get.md @@ -2,7 +2,7 @@ Gets the content of a table for the given key -```bash +```text $ reth db get --help Usage: reth db get [OPTIONS]
diff --git a/book/cli/reth/db/list.md b/book/cli/reth/db/list.md index 3f9ed77e0a..4e3df18a6c 100644 --- a/book/cli/reth/db/list.md +++ b/book/cli/reth/db/list.md @@ -2,7 +2,7 @@ Lists the contents of a table -```bash +```text $ reth db list --help Usage: reth db list [OPTIONS]
diff --git a/book/cli/reth/db/path.md b/book/cli/reth/db/path.md index 6180bab920..6f16ebb5cd 100644 --- a/book/cli/reth/db/path.md +++ b/book/cli/reth/db/path.md @@ -2,7 +2,7 @@ Returns the full database path -```bash +```text $ reth db path --help Usage: reth db path [OPTIONS] diff --git a/book/cli/reth/db/snapshot.md b/book/cli/reth/db/snapshot.md index 2be9ce0f7a..11c3ea72a3 100644 --- a/book/cli/reth/db/snapshot.md +++ b/book/cli/reth/db/snapshot.md @@ -2,7 +2,7 @@ Snapshots tables from database -```bash +```text $ reth db snapshot --help Usage: reth db snapshot [OPTIONS] [SEGMENTS]... diff --git a/book/cli/reth/db/stats.md b/book/cli/reth/db/stats.md index 3859358278..2f104124d3 100644 --- a/book/cli/reth/db/stats.md +++ b/book/cli/reth/db/stats.md @@ -2,7 +2,7 @@ Lists all the tables, their entry count and their size -```bash +```text $ reth db stats --help Usage: reth db stats [OPTIONS] diff --git a/book/cli/reth/db/version.md b/book/cli/reth/db/version.md index 847dc0cb89..8bc6507405 100644 --- a/book/cli/reth/db/version.md +++ b/book/cli/reth/db/version.md @@ -2,7 +2,7 @@ Lists current and local database versions -```bash +```text $ reth db version --help Usage: reth db version [OPTIONS] diff --git a/book/cli/reth/debug.md b/book/cli/reth/debug.md index f41966bebe..12dfaa032e 100644 --- a/book/cli/reth/debug.md +++ b/book/cli/reth/debug.md @@ -2,7 +2,7 @@ Various debug routines -```bash +```text $ reth debug --help Usage: reth debug [OPTIONS] diff --git a/book/cli/reth/import.md b/book/cli/reth/import.md index b92a0c9a18..0c955f1f77 100644 --- a/book/cli/reth/import.md +++ b/book/cli/reth/import.md @@ -2,7 +2,7 @@ This syncs RLP encoded blocks from a file -```bash +```text $ reth import --help Usage: reth import [OPTIONS] diff --git a/book/cli/reth/init.md b/book/cli/reth/init.md index 3f53531760..50f34d7378 100644 --- a/book/cli/reth/init.md +++ b/book/cli/reth/init.md @@ -2,7 +2,7 @@ Initialize the database from a genesis file -```bash +```text $ reth init --help Usage: reth init [OPTIONS] diff --git a/book/cli/reth/node.md b/book/cli/reth/node.md index 15a73bac0d..61d16cd022 100644 --- a/book/cli/reth/node.md +++ b/book/cli/reth/node.md @@ -2,7 +2,7 @@ Start the node -```bash +```text $ reth node --help Usage: reth node [OPTIONS] diff --git a/book/cli/reth/p2p.md b/book/cli/reth/p2p.md index 835ac0a8d6..1047dc6ef2 100644 --- a/book/cli/reth/p2p.md +++ b/book/cli/reth/p2p.md @@ -2,7 +2,7 @@ P2P Debugging utilities -```bash +```text $ reth p2p --help Usage: reth p2p [OPTIONS] diff --git a/book/cli/reth/p2p/body.md b/book/cli/reth/p2p/body.md index a5c3189aff..15b07f26e9 100644 --- a/book/cli/reth/p2p/body.md +++ b/book/cli/reth/p2p/body.md @@ -2,7 +2,7 @@ Download block body -```bash +```text $ reth p2p body --help Usage: reth p2p body [OPTIONS] diff --git a/book/cli/reth/p2p/header.md b/book/cli/reth/p2p/header.md index 52d0630e65..fdadb6c7ad 100644 --- a/book/cli/reth/p2p/header.md +++ b/book/cli/reth/p2p/header.md @@ -2,7 +2,7 @@ Download block header -```bash +```text $ reth p2p header --help Usage: reth p2p header [OPTIONS] diff --git a/book/cli/reth/recover.md b/book/cli/reth/recover.md index 5f2b79d6dd..cb39a6a3ed 100644 --- a/book/cli/reth/recover.md +++ b/book/cli/reth/recover.md @@ -2,7 +2,7 @@ Scripts for node recovery -```bash +```text $ reth recover --help Usage: reth recover [OPTIONS] diff --git a/book/cli/reth/recover/storage-tries.md b/book/cli/reth/recover/storage-tries.md index f13cc9e31f..7ac2beb096 100644 --- a/book/cli/reth/recover/storage-tries.md +++ b/book/cli/reth/recover/storage-tries.md @@ -2,7 +2,7 @@ Recover the node by deleting dangling storage tries -```bash +```text $ reth recover storage-tries --help Usage: reth recover storage-tries [OPTIONS] diff --git a/book/cli/reth/stage.md b/book/cli/reth/stage.md index a0365e98f2..ad022a1afa 100644 --- a/book/cli/reth/stage.md +++ b/book/cli/reth/stage.md @@ -2,7 +2,7 @@ Manipulate individual stages -```bash +```text $ reth stage --help Usage: reth stage [OPTIONS] diff --git a/book/cli/reth/stage/drop.md b/book/cli/reth/stage/drop.md index 97e437d878..01ee7c04d5 100644 --- a/book/cli/reth/stage/drop.md +++ b/book/cli/reth/stage/drop.md @@ -2,7 +2,7 @@ Drop a stage's tables from the database -```bash +```text $ reth stage drop --help Usage: reth stage drop [OPTIONS] diff --git a/book/cli/reth/stage/dump.md b/book/cli/reth/stage/dump.md index c5f08bb2f5..b1d84dd621 100644 --- a/book/cli/reth/stage/dump.md +++ b/book/cli/reth/stage/dump.md @@ -2,7 +2,7 @@ Dumps a stage from a range into a new database -```bash +```text $ reth stage dump --help Usage: reth stage dump [OPTIONS] diff --git a/book/cli/reth/stage/dump/account-hashing.md b/book/cli/reth/stage/dump/account-hashing.md index 7524e4ac73..79757d4e57 100644 --- a/book/cli/reth/stage/dump/account-hashing.md +++ b/book/cli/reth/stage/dump/account-hashing.md @@ -2,7 +2,7 @@ AccountHashing stage -```bash +```text $ reth stage dump account-hashing --help Usage: reth stage dump account-hashing [OPTIONS] --output-db --from --to diff --git a/book/cli/reth/stage/dump/execution.md b/book/cli/reth/stage/dump/execution.md index 2025012ad3..e023065703 100644 --- a/book/cli/reth/stage/dump/execution.md +++ b/book/cli/reth/stage/dump/execution.md @@ -2,7 +2,7 @@ Execution stage -```bash +```text $ reth stage dump execution --help Usage: reth stage dump execution [OPTIONS] --output-db --from --to diff --git a/book/cli/reth/stage/dump/merkle.md b/book/cli/reth/stage/dump/merkle.md index e69b51cdde..93a01d16ae 100644 --- a/book/cli/reth/stage/dump/merkle.md +++ b/book/cli/reth/stage/dump/merkle.md @@ -2,7 +2,7 @@ Merkle stage -```bash +```text $ reth stage dump merkle --help Usage: reth stage dump merkle [OPTIONS] --output-db --from --to diff --git a/book/cli/reth/stage/dump/storage-hashing.md b/book/cli/reth/stage/dump/storage-hashing.md index 7ef46bb5f3..5e836213a7 100644 --- a/book/cli/reth/stage/dump/storage-hashing.md +++ b/book/cli/reth/stage/dump/storage-hashing.md @@ -2,7 +2,7 @@ StorageHashing stage -```bash +```text $ reth stage dump storage-hashing --help Usage: reth stage dump storage-hashing [OPTIONS] --output-db --from --to diff --git a/book/cli/reth/stage/run.md b/book/cli/reth/stage/run.md index c7237cbb23..3cbb1af355 100644 --- a/book/cli/reth/stage/run.md +++ b/book/cli/reth/stage/run.md @@ -2,7 +2,7 @@ Run a single stage. -```bash +```text $ reth stage run --help Usage: reth stage run [OPTIONS] --from --to diff --git a/book/cli/reth/stage/unwind.md b/book/cli/reth/stage/unwind.md index 6e276803b5..506d357617 100644 --- a/book/cli/reth/stage/unwind.md +++ b/book/cli/reth/stage/unwind.md @@ -2,7 +2,7 @@ Unwinds a certain block range, deleting it from the database -```bash +```text $ reth stage unwind --help Usage: reth stage unwind [OPTIONS] diff --git a/book/cli/reth/stage/unwind/num-blocks.md b/book/cli/reth/stage/unwind/num-blocks.md index 0a9bc15c2a..ce3705df7b 100644 --- a/book/cli/reth/stage/unwind/num-blocks.md +++ b/book/cli/reth/stage/unwind/num-blocks.md @@ -2,7 +2,7 @@ Unwinds the given number of blocks from the database -```bash +```text $ reth stage unwind num-blocks --help Usage: reth stage unwind num-blocks [OPTIONS] diff --git a/book/cli/reth/stage/unwind/to-block.md b/book/cli/reth/stage/unwind/to-block.md index d3a5cc712a..bd3a85dc59 100644 --- a/book/cli/reth/stage/unwind/to-block.md +++ b/book/cli/reth/stage/unwind/to-block.md @@ -2,7 +2,7 @@ Unwinds the database until the given block number (range is inclusive) -```bash +```text $ reth stage unwind to-block --help Usage: reth stage unwind to-block [OPTIONS] diff --git a/book/cli/reth/test-vectors.md b/book/cli/reth/test-vectors.md index b79b399dd7..b27a6c73e3 100644 --- a/book/cli/reth/test-vectors.md +++ b/book/cli/reth/test-vectors.md @@ -2,7 +2,7 @@ Generate Test Vectors -```bash +```text $ reth test-vectors --help Usage: reth test-vectors [OPTIONS] diff --git a/book/cli/reth/test-vectors/tables.md b/book/cli/reth/test-vectors/tables.md index f54af54b3a..47c89a8023 100644 --- a/book/cli/reth/test-vectors/tables.md +++ b/book/cli/reth/test-vectors/tables.md @@ -2,7 +2,7 @@ Generates test vectors for specified tables. If no table is specified, generate for all -```bash +```text $ reth test-vectors tables --help Usage: reth test-vectors tables [OPTIONS] [NAMES]...