Update documentation

.github/workflows/raspberry_rust.yml

@@ -43,7 +43,7 @@ jobs:
             toolchain: stable
             components: clippy
             cargo-command: clippy
-            args: --features=raspberry -- -A clippy::too_many_arguments
+            args: --features=raspberry -- -D warnings -A clippy::too_many_arguments
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@v1

.github/workflows/rust.yml

@@ -103,4 +103,4 @@ jobs:
           components: clippy
       - uses: Swatinem/rust-cache@v2
       # `too_many_arguments` is relatively arbitrary
-      - run: cargo clippy -- -A clippy::too_many_arguments
+      - run: cargo clippy -- -A clippy::too_many_arguments -D warnings

cargo-espflash/Cargo.toml

@@ -1,21 +1,13 @@
 [package]
 name = "cargo-espflash"
 version = "2.0.0-rc.3"
-authors = [
-    "Robin Appelman <[email protected]>",
-    "Jesse Braham <[email protected]>",
-]
+authors = ["Robin Appelman <[email protected]>", "Jesse Braham <[email protected]>"]
 edition = "2021"
 rust-version = "1.63"
 description = "Cargo subcommand for flashing Espressif devices over serial"
 repository = "https://github.com/esp-rs/espflash"
 license = "MIT OR Apache-2.0"
-keywords = [
-    "cargo",
-    "cli",
-    "embedded",
-    "esp",
-]
+keywords = ["cargo", "cli", "embedded", "esp"]
 categories = [
     "command-line-utilities",
     "development-tools",
@@ -33,7 +25,7 @@ cargo = { version = "0.66.0", features = ["vendored-openssl"] }
 cargo_metadata = "0.15.2"
 clap = { version = "4.0.32", features = ["derive"] }
 env_logger = "0.10.0"
-esp-idf-part = "0.1.2"
+esp-idf-part = "0.2.0"
 espflash = { version = "=2.0.0-rc.3", path = "../espflash" }
 log = "0.4.17"
 miette = { version = "5.5.0", features = ["fancy"] }

cargo-espflash/src/main.rs

@@ -49,9 +49,7 @@ enum CargoSubcommand {
 
 #[derive(Debug, Subcommand)]
 enum Commands {
-    /// Display information about the connected board and exit without flashing
     BoardInfo(ConnectArgs),
-    /// Flash an application to a target device
     Flash(FlashArgs),
     Monitor(MonitorArgs),
     PartitionTable(PartitionTableArgs),

espflash/Cargo.toml

@@ -1,25 +1,14 @@
 [package]
 name = "espflash"
 version = "2.0.0-rc.3"
-authors = [
-    "Robin Appelman <[email protected]>",
-    "Jesse Braham <[email protected]>",
-]
+authors = ["Robin Appelman <[email protected]>", "Jesse Braham <[email protected]>"]
 edition = "2021"
 rust-version = "1.63"
 description = "A command-line tool for flashing Espressif devices over serial"
 repository = "https://github.com/esp-rs/espflash"
 license = "MIT OR Apache-2.0"
-keywords = [
-    "cli",
-    "embedded",
-    "esp",
-]
-categories = [
-    "command-line-utilities",
-    "development-tools",
-    "embedded",
-]
+keywords = ["cli", "embedded", "esp"]
+categories = ["command-line-utilities", "development-tools", "embedded"]
 
 [package.metadata.binstall]
 pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ target }.{ archive-format }"
@@ -41,11 +30,11 @@ binread = "2.2.0"
 bytemuck = { version = "1.12.3", features = ["derive"] }
 clap = { version = "4.0.32", features = ["derive", "env"], optional = true }
 comfy-table = { version = "6.1.4", optional = true }
-crossterm = { version = "0.25.0", optional = true }
+crossterm = { version = "0.26.1", optional = true }
 dialoguer = { version = "0.10.2", optional = true }
 directories-next = { version = "2.0.0", optional = true }
-esp-idf-part = "0.1.2"
 env_logger = { version = "0.10.0", optional = true }
+esp-idf-part = "0.2.0"
 flate2 = "1.0.25"
 indicatif = { version = "0.17.2", optional = true }
 lazy_static = { version = "1.4.0", optional = true }
@@ -68,8 +57,18 @@ xmas-elf = "0.9.0"
 [features]
 default = ["cli"]
 cli = [
-    "dep:addr2line", "dep:clap", "dep:comfy-table", "dep:crossterm", "dep:dialoguer",
-    "dep:directories-next", "dep:env_logger", "dep:indicatif", "dep:lazy_static",
-    "dep:parse_int", "dep:regex", "dep:serde-hex", "dep:update-informer"
+    "dep:addr2line",
+    "dep:clap",
+    "dep:comfy-table",
+    "dep:crossterm",
+    "dep:dialoguer",
+    "dep:directories-next",
+    "dep:env_logger",
+    "dep:indicatif",
+    "dep:lazy_static",
+    "dep:parse_int",
+    "dep:regex",
+    "dep:serde-hex",
+    "dep:update-informer",
 ]
 raspberry = ["dep:rppal"]

espflash/README.md

@@ -42,8 +42,8 @@ If you would like to flash from a Raspberry Pi using the built-in UART periphera
 cargo install espflash --features=raspberry
 ```
 
-[libuv]: (https://libuv.org/)
-[cargo-binstall]: (https://github.com/cargo-bins/cargo-binstall)
+[libuv]: https://libuv.org/
+[cargo-binstall]: https://github.com/cargo-bins/cargo-binstall
 [releases]: https://github.com/esp-rs/espflash/releases
 
 ## Usage

espflash/src/bin/espflash.rs

@@ -30,9 +30,7 @@ struct Cli {
 
 #[derive(Debug, Subcommand)]
 enum Commands {
-    /// Display information about the connected board and exit without flashing
     BoardInfo(ConnectArgs),
-    /// Flash an application to a target device
     Flash(FlashArgs),
     Monitor(MonitorArgs),
     PartitionTable(PartitionTableArgs),
@@ -42,30 +40,32 @@ enum Commands {
 
 #[derive(Debug, Args)]
 struct FlashArgs {
-    /// ELF image to flash
-    image: PathBuf,
-
+    /// Connection configuration
     #[clap(flatten)]
     connect_args: ConnectArgs,
+    /// Flashing configuration
     #[clap(flatten)]
     pub flash_config_args: FlashConfigArgs,
+    /// Flashing arguments
     #[clap(flatten)]
     flash_args: cli::FlashArgs,
+    /// ELF image to flash
+    image: PathBuf,
 }
 
 #[derive(Debug, Args)]
 struct SaveImageArgs {
+    /// ELF image to flash
+    image: PathBuf,
     /// Image format to flash
     #[arg(long, value_enum)]
     format: Option<ImageFormatKind>,
-
+    /// Flashing configuration
     #[clap(flatten)]
     pub flash_config_args: FlashConfigArgs,
+    /// Sage image arguments
     #[clap(flatten)]
     save_image_args: cli::SaveImageArgs,
-
-    /// ELF image to flash
-    image: PathBuf,
 }
 
 /// Writes a binary file to a specific address in the chip's flash
@@ -76,11 +76,12 @@ struct WriteBinArgs {
     pub addr: u32,
     /// File containing the binary data to write
     pub bin_file: String,
-
+    /// Connection configuration
     #[clap(flatten)]
     connect_args: ConnectArgs,
 }
 
+/// Parses a string as a 32-bit unsigned integer.
 fn parse_uint32(input: &str) -> Result<u32, ParseIntError> {
     parse_int::parse(input)
 }

espflash/src/cli/config.rs

@@ -43,6 +43,7 @@ pub struct UsbDevice {
 }
 
 impl UsbDevice {
+    /// Check if the given USB port matches this device
     pub fn matches(&self, port: &UsbPortInfo) -> bool {
         self.vid == port.vid && self.pid == port.pid
     }
@@ -57,6 +58,7 @@ pub struct Config {
     /// Preferred USB devices
     #[serde(default)]
     pub usb_device: Vec<UsbDevice>,
+    /// Path of the file to save the config to
     #[serde(skip)]
     save_path: PathBuf,
 }
@@ -76,6 +78,7 @@ impl Config {
         Ok(config)
     }
 
+    /// Save the config to the config file
     pub fn save_with<F: Fn(&mut Self)>(&self, modify_fn: F) -> Result<()> {
         let mut copy = self.clone();
         modify_fn(&mut copy);