🔨 Adjust INI comments (MarlinFirmware#25183)

Infobitas · Apr 7, 2023 · fecb667 · fecb667
1 parent f7485ce
commit fecb667
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 24 deletions.
diff --git a/ini/renamed.ini b/ini/renamed.ini
@@ -21,46 +21,35 @@ board     = genericSTM32F103RE
 # List of environment names that are no longer used
 #
 
-[env:STM32F103RET6_creality_maple]
-# Renamed to STM32F103RE_creality_maple
+[env:STM32F103RET6_creality_maple]    ;=> STM32F103RE_creality_maple
 extends = renamed
 
-[env:STM32F103RET6_creality]
-# Renamed to STM32F103RE_creality
+[env:STM32F103RET6_creality]          ;=> STM32F103RE_creality
 extends = renamed
 
-[env:STM32F103RET6_creality_xfer]
-# Renamed to STM32F103RE_creality_xfer
+[env:STM32F103RET6_creality_xfer]     ;=> STM32F103RE_creality_xfer
 extends = renamed
 
-[env:STM32F103RC_btt_512K]
-# Renamed to STM32F103RE_btt
+[env:STM32F103RC_btt_512K]            ;=> STM32F103RE_btt
 extends = renamed
 
-[env:STM32F103RC_btt_512K_USB]
-# Renamed to STM32F103RE_btt_USB
+[env:STM32F103RC_btt_512K_USB]        ;=> STM32F103RE_btt_USB
 extends = renamed
 
-[env:STM32F103RC_btt_512K_maple]
-# Renamed to STM32F103RE_btt_maple
+[env:STM32F103RC_btt_512K_maple]      ;=> STM32F103RE_btt_maple
 extends = renamed
 
-[env:STM32F103RC_btt_512K_USB_maple]
-# Renamed to STM32F103RE_btt_USB_maple
+[env:STM32F103RC_btt_512K_USB_maple]  ;=> STM32F103RE_btt_USB_maple
 extends = renamed
 
-[env:STM32F103RC_meeb]
-# Renamed to STM32F103RC_meeb_maple
+[env:STM32F103RC_meeb]                ;=> STM32F103RC_meeb_maple
 extends = renamed
 
-[env:STM32F103VE_GTM32]
-# Renamed to STM32F103VE_GTM32_maple
+[env:STM32F103VE_GTM32]               ;=> STM32F103VE_GTM32_maple
 extends = renamed
 
-[env:mks_robin_nano35]
-# Renamed to mks_robin_nano_v1v2
+[env:mks_robin_nano35]                ;=> mks_robin_nano_v1v2
 extends = renamed
 
-[env:mks_robin_nano35_maple]
-# Renamed to mks_robin_nano_v1v2_maple
+[env:mks_robin_nano35_maple]          ;=> mks_robin_nano_v1v2_maple
 extends = renamed
diff --git a/ini/stm32f1-maple.ini b/ini/stm32f1-maple.ini
@@ -137,7 +137,7 @@ debug_tool           = jlink
 upload_protocol      = jlink
 
 #
-# Creality (STM32F103RET6)
+# Creality 512K (STM32F103RE) for new 64KiB bootloader (CR-10 Smart Pro printer)
 #
 [env:STM32F103RE_creality_smartPro_maple]
 extends              = env:STM32F103RE_creality_maple

diff --git a/ini/stm32f1.ini b/ini/stm32f1.ini
@@ -135,7 +135,11 @@ debug_tool                  = jlink
 upload_protocol             = jlink
 
 #
-# Custom upload to SD via Marlin with Binary Protocol
+# Creality (STM32F103Rx)
+# With custom upload to SD via Marlin with binary protocol.
+# Requires Marlin with BINARY_FILE_TRANSFER already installed on the target board.
+# If CUSTOM_FIRMWARE_UPLOAD is also installed, Marlin will reboot the board to install the firmware.
+# Currently CUSTOM_FIRMWARE_UPLOAD must also be enabled to use 'xfer' build envs.
 #
 [STM32F103Rx_creality_xfer]
 extends         = STM32F103Rx_creality
@@ -151,10 +155,16 @@ upload_protocol = custom
 extends = STM32F103Rx_creality
 board   = genericSTM32F103RE
 
+#
+# Creality 512K (STM32F103RE) with custom binary upload to SD (see above).
+#
 [env:STM32F103RE_creality_xfer]
 extends = STM32F103Rx_creality_xfer
 board   = genericSTM32F103RE
 
+#
+# Creality 512K (STM32F103RE) for new 64KiB bootloader (CR-10 Smart Pro printer)
+#
 [env:STM32F103RE_creality_smartPro]
 extends                     = STM32F103Rx_creality
 board_build.offset          = 0x10000
@@ -167,6 +177,9 @@ board_upload.offset_address = 0x08010000
 extends = STM32F103Rx_creality
 board   = genericSTM32F103RC
 
+#
+# Creality 256K (STM32F103RC) with custom binary upload to SD (see above).
+#
 [env:STM32F103RC_creality_xfer]
 extends = STM32F103Rx_creality_xfer
 board   = genericSTM32F103RC

diff --git a/ini/stm32g0.ini b/ini/stm32g0.ini
@@ -61,6 +61,9 @@ debug_tool                  = stlink
 #
 # BigTreeTech SKR Mini E3 V3.0 / Manta E3 EZ V1.0 / Manta M4P V1.0 / Manta M5P V1.0 (STM32G0B1RET6 ARM Cortex-M0+)
 # Custom upload to SD via Marlin with Binary Protocol
+# Requires Marlin with BINARY_FILE_TRANSFER already installed on the target board.
+# If CUSTOM_FIRMWARE_UPLOAD is also installed, Marlin will reboot the board to install the firmware.
+# Currently CUSTOM_FIRMWARE_UPLOAD must also be enabled to use 'xfer' build envs.
 #
 [env:STM32G0B1RE_btt_xfer]
 extends         = env:STM32G0B1RE_btt