Document that subcommand help exists (#3218)

esp-rs · Mar 5, 2025 · 60e0127 · 60e0127
1 parent ef1b3cf
commit 60e0127
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/xtask/README.md b/xtask/README.md
@@ -26,6 +26,19 @@ Options:
   -h, --help  Print help
 ```
 
+You can get help for subcommands, too!
+
+```text
+cargo xtask build-examples --help
+    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.21s
+     Running `target\debug\xtask.exe build-examples --help`
+Build all examples for the specified chip
+
+Usage: xtask.exe build-examples [OPTIONS] <PACKAGE> <CHIP> [EXAMPLE]
+
+...
+```
+
 ## Test/example metadata use
 
 Each test and example can specify metadata. This metadata is read, interpreted and used by the