chore: alias of datadir.static-files and upate book cli (#10856)

Signed-off-by: 9547 <29431502+9547@users.noreply.github.com>
paradigmxyz · Sep 12, 2024 · b85a4e8 · b85a4e8
1 parent c1b5fbb
commit b85a4e8
Show file tree

Hide file tree

Showing 18 changed files with 23 additions and 18 deletions.
diff --git a/book/cli/reth/db.md b/book/cli/reth/db.md
@@ -47,7 +47,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/debug/build-block.md b/book/cli/reth/debug/build-block.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/debug/execution.md b/book/cli/reth/debug/execution.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/debug/in-memory-merkle.md b/book/cli/reth/debug/in-memory-merkle.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/debug/merkle.md b/book/cli/reth/debug/merkle.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/debug/replay-engine.md b/book/cli/reth/debug/replay-engine.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/import.md b/book/cli/reth/import.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/init-state.md b/book/cli/reth/init-state.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/init.md b/book/cli/reth/init.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/node.md b/book/cli/reth/node.md
@@ -58,7 +58,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
 Networking:

diff --git a/book/cli/reth/p2p.md b/book/cli/reth/p2p.md
@@ -222,7 +222,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
 Database:

diff --git a/book/cli/reth/prune.md b/book/cli/reth/prune.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/recover/storage-tries.md b/book/cli/reth/recover/storage-tries.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/stage/drop.md b/book/cli/reth/stage/drop.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/stage/dump.md b/book/cli/reth/stage/dump.md
@@ -42,7 +42,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/stage/run.md b/book/cli/reth/stage/run.md
@@ -35,7 +35,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/book/cli/reth/stage/unwind.md b/book/cli/reth/stage/unwind.md
@@ -40,7 +40,7 @@ Datadir:
 
           [default: default]
 
-      --datadir.static_files <PATH>
+      --datadir.static-files <PATH>
           The absolute path to store static files in.
 
       --config <FILE>

diff --git a/crates/node/core/src/args/datadir_args.rs b/crates/node/core/src/args/datadir_args.rs
@@ -20,7 +20,12 @@ pub struct DatadirArgs {
     pub datadir: MaybePlatformPath<DataDirPath>,
 
     /// The absolute path to store static files in.
-    #[arg(long = "datadir.static_files", verbatim_doc_comment, value_name = "PATH")]
+    #[arg(
+        long = "datadir.static-files",
+        alias = "datadir.static_files",
+        value_name = "PATH",
+        verbatim_doc_comment
+    )]
     pub static_files_path: Option<PathBuf>,
 }