ravedude: add comments for possibly confusing code

Rahix · Jun 8, 2024 · 07e201e · 07e201e
1 parent 0825c28
commit 07e201e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/ravedude/src/config.rs b/ravedude/src/config.rs
@@ -134,6 +134,8 @@ pub struct BoardAvrdudeOptions {
         serialize_with = "serialize_baudrate",
         deserialize_with = "deserialize_baudrate"
     )]
+    // Inner option to represent whether the baudrate exists, outer option to allow for overriding.
+    // Option<if baudrate == -1 { None } else { NonZeroU32(baudrate) }>
     pub baudrate: Option<Option<NonZeroU32>>,
     pub do_chip_erase: Option<bool>,
 }

diff --git a/ravedude/src/main.rs b/ravedude/src/main.rs
@@ -79,6 +79,8 @@ struct Args {
     /// * nano168
     /// * duemilanove
     #[structopt(name = "BOARD", verbatim_doc_comment)]
+    // When Ravedude.toml exists, the binary is placed where the board should be. This is an OsString to not lose
+    // informaton when we have to take the board as the binary.
     board: Option<OsString>,
 
     /// The binary to be flashed.