Improve help description

rust-embedded · Dec 27, 2023 · a4ee23e · a4ee23e
1 parent 1b7eea6
commit a4ee23e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/main.rs b/src/main.rs
@@ -204,7 +204,10 @@ fn run() -> Result<()> {
                 .long("base-address-shift")
                 .alias("base_address_shift")
                 .action(ArgAction::Set)
-                .help("Shift base address for all peripherals"),
+                .help("Add offset to all base addresses on all peripherals in the SVD file.")
+                .long_help("Add offset to all base addresses on all peripherals in the SVD file.
+Useful for soft-cores where the peripheral address range isn't necessarily fixed.
+Ignore this option if you are not building your own FPGA based soft-cores."),
         )
         .arg(
             Arg::new("log_level")