Fixing documentation

quartiq · Apr 19, 2022 · 0c5187c · 0c5187c
1 parent c8dc0c2
commit 0c5187c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+* The W5500 now operates as an external MAC, and smoltcp is used as the network stack.
+* DHCP support has been added, `netmask`, `ip-address`, and `gateway` settings have been removed.
+  Settings are backwards compatible with previous Booster releases.
 
 ## [0.3.0]
 

diff --git a/src/settings/global_settings.rs b/src/settings/global_settings.rs
@@ -39,6 +39,9 @@ fn identifier_is_valid(id: &str) -> bool {
 #[derive(Serialize, Deserialize)]
 struct BoosterMainBoardData {
     version: SemVersion,
+
+    // Note: The IP address, gateway, and netmask are unused, but left here to maintain backwards compatibility with
+    // settings version v1.0.0
     _unused_ip_address: [u8; 4],
     broker_address: [u8; 4],
     _unused_gateway_address: [u8; 4],