Skip to content

Commit cfb4661

Browse files
zackeesclaude
andauthored
fix(fbuild-deploy): repair broken intra-doc links and fmt drift (#201)
- esp32_native.rs module-level `//!` docs use `crate::esp32::...` instead of `super::esp32::...`. Rustdoc does not resolve `super` from inner doc comments at the module file level under rustc 1.94.1, which broke `cargo doc --workspace --no-deps` with `RUSTDOCFLAGS=-D warnings`. Also fully qualify `VerifyOutcome` as `crate::esp32::VerifyOutcome` since it is not in scope at the module-doc resolution site. - esp32.rs: apply `cargo fmt` — the native-write early-return block had drifted out of the canonical layout. Fixes CI runs 24900888165 (Documentation) and 24900888192 (Formatting). Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 2aa2e34 commit cfb4661

2 files changed

Lines changed: 8 additions & 9 deletions

File tree

crates/fbuild-deploy/src/esp32.rs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1245,11 +1245,9 @@ impl Deployer for Esp32Deployer {
12451245

12461246
#[cfg(feature = "espflash-native")]
12471247
if self.use_native_write {
1248-
if let Some(result) =
1249-
native_write_or_fallback(port, "write-flash", || {
1250-
self.try_deploy_native(firmware_path, port)
1251-
})
1252-
{
1248+
if let Some(result) = native_write_or_fallback(port, "write-flash", || {
1249+
self.try_deploy_native(firmware_path, port)
1250+
}) {
12531251
return Ok(result);
12541252
}
12551253
}

crates/fbuild-deploy/src/esp32_native.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Native ESP32 `verify-flash` **and** `write-flash` implementations
22
//! backed by the [`espflash`] crate. Alternatives to the default
3-
//! [`super::esp32::Esp32Deployer`] path, which shells out to Python
3+
//! [`crate::esp32::Esp32Deployer`] path, which shells out to Python
44
//! `esptool`.
55
//!
66
//! # Why (issue #66)
@@ -16,7 +16,8 @@
1616
//! # Scope
1717
//!
1818
//! * `verify-flash` — three regions (bootloader / partitions /
19-
//! firmware), same [`VerifyOutcome`] semantics as the esptool path.
19+
//! firmware), same [`crate::esp32::VerifyOutcome`] semantics as the
20+
//! esptool path.
2021
//! * `write-flash` — same three regions, same
2122
//! [`DeploymentResult`]/[`DeployOutcome`] shape as the esptool path.
2223
//! Progress callbacks from espflash are bridged into `tracing` so the
@@ -36,9 +37,9 @@
3637
//! # Opt-in
3738
//!
3839
//! `verify-flash` is guarded by
39-
//! [`super::esp32::Esp32Deployer::with_native_verify`] (daemon env:
40+
//! [`crate::esp32::Esp32Deployer::with_native_verify`] (daemon env:
4041
//! `FBUILD_USE_ESPFLASH_VERIFY`), and `write-flash` by
41-
//! [`super::esp32::Esp32Deployer::with_native_write`] (daemon env:
42+
//! [`crate::esp32::Esp32Deployer::with_native_write`] (daemon env:
4243
//! `FBUILD_USE_ESPFLASH_WRITE`). The two flags are independent —
4344
//! users can flip one without the other while the native write path
4445
//! accumulates bench time on every ESP32 family member.

0 commit comments

Comments
 (0)