all: Upgrade codespell to v2.4.1.

cclauss · dpgeorge · commit 5e206fdeb522 · 2025-02-25T16:11:33.000+11:00
This commit upgrades from codespell==2.2.6 to the current codespell==2.4.1,
adding emac to the ignore-words-list.

Signed-off-by: Christian Clauss &lt;cclauss@me.com&gt;
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -8,6 +8,6 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     # codespell version should be kept in sync with .pre-commit-config.yml
-    - run: pip install --user codespell==2.2.6 tomli
+    - run: pip install --user codespell==2.4.1 tomli
     - run: codespell
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -19,7 +19,7 @@ repos:
       - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
     # Version should be kept in sync with .github/workflows/codespell.yml
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
         name: Spellcheck for changed files (codespell)
diff --git a/docs/reference/isr_rules.rst b/docs/reference/isr_rules.rst
@@ -209,7 +209,7 @@ issue a further interrupt. It then schedules a callback to process the data.
 
 Scheduled callbacks should comply with the principles of interrupt handler design outlined below. This is to
 avoid problems resulting from I/O activity and the modification of shared data which can arise in any code
-which pre-empts the main program loop.
+which preempts the main program loop.
 
 Execution time needs to be considered in relation to the frequency with which interrupts can occur. If an
 interrupt occurs while the previous callback is executing, a further instance of the callback will be queued
diff --git a/docs/reference/speed_python.rst b/docs/reference/speed_python.rst
@@ -219,7 +219,7 @@ process known as garbage collection reclaims the memory used by these redundant
 objects and the allocation is then tried again - a process which can take several
 milliseconds.
 
-There may be benefits in pre-empting this by periodically issuing `gc.collect()`.
+There may be benefits in preempting this by periodically issuing `gc.collect()`.
 Firstly doing a collection before it is actually required is quicker - typically on the
 order of 1ms if done frequently. Secondly you can determine the point in code
 where this time is used rather than have a longer delay occur at random points,
diff --git a/examples/usercmodule/cexample/examplemodule.c b/examples/usercmodule/cexample/examplemodule.c
@@ -74,7 +74,7 @@ MP_DEFINE_CONST_OBJ_TYPE(
 // - A custom representation for __repr__ and __str__.
 // - Custom attribute handling to create a read/write "property".
 //
-// It re-uses some of the elements of the basic Timer class. This is allowed
+// It reuses some of the elements of the basic Timer class. This is allowed
 // because they both use example_Timer_obj_t as the instance structure.
 
 // Handles AdvancedTimer.__repr__, AdvancedTimer.__str__.
diff --git a/extmod/modlwip.c b/extmod/modlwip.c
@@ -476,7 +476,7 @@ static void _lwip_tcp_err_unaccepted(void *arg, err_t err) {
     // because it's only ever used by lwIP if tcp_connect is called on the TCP PCB.
     lwip_socket_obj_t *socket = (lwip_socket_obj_t *)pcb->connected;
 
-    // Array is not volatile because thiss callback is executed within the lwIP context
+    // Array is not volatile because this callback is executed within the lwIP context
     uint8_t alloc = socket->incoming.connection.alloc;
     struct tcp_pcb **tcp_array = (struct tcp_pcb **)lwip_socket_incoming_array(socket);
 
diff --git a/ports/esp32/mpthreadport.c b/ports/esp32/mpthreadport.c
@@ -213,7 +213,7 @@ int mp_thread_mutex_lock(mp_thread_mutex_t *mutex, int wait) {
 
 void mp_thread_mutex_unlock(mp_thread_mutex_t *mutex) {
     xSemaphoreGive(mutex->handle);
-    // Python threads run at equal priority, so pre-emptively yield here to
+    // Python threads run at equal priority, so preemptively yield here to
     // prevent pathological imbalances where a thread unlocks and then
     // immediately re-locks a mutex before a context switch can occur, leaving
     // another thread waiting for an unbounded period of time.
diff --git a/ports/mimxrt/boards/ADAFRUIT_METRO_M7/mpconfigboard.h b/ports/mimxrt/boards/ADAFRUIT_METRO_M7/mpconfigboard.h
@@ -52,7 +52,7 @@
     { IOMUXC_GPIO_02_LPI2C1_SCL }, { IOMUXC_GPIO_01_LPI2C1_SDA }, \
     { IOMUXC_GPIO_10_LPI2C2_SCL }, { IOMUXC_GPIO_09_LPI2C2_SDA },
 
-// Wifi Deinitions
+// Wifi Definitions
 #define MICROPY_PY_NETWORK_HOSTNAME_DEFAULT "mpy-metro-m7"
 
 #define MICROPY_HW_WIFI_SPI_ID       (0)
diff --git a/ports/mimxrt/eth.c b/ports/mimxrt/eth.c
@@ -327,7 +327,7 @@ static void eth_gpio_init(const iomux_table_t iomux_table[], size_t iomux_table_
     }
 }
 
-// eth_phy_init: Initilaize the PHY interface
+// eth_phy_init: Initialize the PHY interface
 static void eth_phy_init(phy_handle_t *phyHandle, phy_config_t *phy_config,
     phy_speed_t *speed, phy_duplex_t *duplex, uint32_t phy_settle_time) {
 
diff --git a/ports/mimxrt/hal/flexspi_flash_config.h b/ports/mimxrt/hal/flexspi_flash_config.h
@@ -119,7 +119,7 @@ enum
     kFlexSpiMiscOffset_WordAddressableEnable    = 3, // !< Bit for Word Addressable enable
     kFlexSpiMiscOffset_SafeConfigFreqEnable     = 4, // !< Bit for Safe Configuration Frequency enable
     kFlexSpiMiscOffset_PadSettingOverrideEnable = 5, // !< Bit for Pad setting override enable
-    kFlexSpiMiscOffset_DdrModeEnable            = 6, // !< Bit for DDR clock confiuration indication.
+    kFlexSpiMiscOffset_DdrModeEnable            = 6, // !< Bit for DDR clock configuration indication.
 };
 
 // !@brief Flash Type Definition
diff --git a/ports/mimxrt/sdcard.c b/ports/mimxrt/sdcard.c
@@ -980,7 +980,7 @@ bool sdcard_power_on(mimxrt_sdcard_obj_t *card) {
         return false;
     }
 
-    // Finialize initialization
+    // Finalize initialization
     card->state->initialized = true;
     return true;
 }
diff --git a/ports/nrf/boards/MICROBIT/modules/microbitfont.h b/ports/nrf/boards/MICROBIT/modules/microbitfont.h
@@ -36,7 +36,7 @@ DEALINGS IN THE SOFTWARE.
   *
   * Example: { 0x08, 0x08, 0x08, 0x0, 0x08 }
   *
-  * The above will produce an exclaimation mark on the second column in form the left.
+  * The above will produce an exclamation mark on the second column in form the left.
   *
   * We could compress further, but the complexity of decode would likely outweigh the gains.
   */
diff --git a/ports/rp2/main.c b/ports/rp2/main.c
@@ -90,7 +90,7 @@ int main(int argc, char **argv) {
     // Set the MCU frequency and as a side effect the peripheral clock to 48 MHz.
     set_sys_clock_khz(SYS_CLK_KHZ, false);
 
-    // Hook for setting up anything that needs to be super early in the bootup process.
+    // Hook for setting up anything that needs to be super early in the boot-up process.
     MICROPY_BOARD_STARTUP();
 
     #if MICROPY_HW_ENABLE_UART_REPL
diff --git a/ports/samd/mcu/samd21/mpconfigmcu.h b/ports/samd/mcu/samd21/mpconfigmcu.h
@@ -1,4 +1,4 @@
-// Deinitions common to all SAMD21 boards
+// Definitions common to all SAMD21 boards
 #include "samd21.h"
 
 #define MICROPY_CONFIG_ROM_LEVEL        (MICROPY_CONFIG_ROM_LEVEL_BASIC_FEATURES)
diff --git a/ports/samd/mcu/samd51/mpconfigmcu.h b/ports/samd/mcu/samd51/mpconfigmcu.h
@@ -1,4 +1,4 @@
-// Deinitions common to all SAMD51 boards
+// Definitions common to all SAMD51 boards
 #include "samd51.h"
 
 #define MICROPY_CONFIG_ROM_LEVEL        (MICROPY_CONFIG_ROM_LEVEL_FULL_FEATURES)
diff --git a/ports/windows/windows_mphal.c b/ports/windows/windows_mphal.c
@@ -70,7 +70,7 @@ void mp_hal_stdio_mode_orig(void) {
 }
 
 // Handler to be installed by SetConsoleCtrlHandler, currently used only to handle Ctrl-C.
-// This handler has to be installed just once (this has to be done elswhere in init code).
+// This handler has to be installed just once (this has to be done elsewhere in init code).
 // Previous versions of the mp_hal code would install a handler whenever Ctrl-C input is
 // allowed and remove the handler again when it is not. That is not necessary though (1),
 // and it might introduce problems (2) because console notifications are delivered to the
diff --git a/py/reader.h b/py/reader.h
@@ -48,7 +48,7 @@ void mp_reader_new_file(mp_reader_t *reader, qstr filename);
 void mp_reader_new_file_from_fd(mp_reader_t *reader, int fd, bool close_fd);
 
 // Try to efficiently read the given number of bytes from a ROM-based reader.
-// Returns a valid, non-NULL pointer to the requseted data if the reader points to ROM.
+// Returns a valid, non-NULL pointer to the requested data if the reader points to ROM.
 // Returns NULL if the reader does not point to ROM.
 const uint8_t *mp_reader_try_read_rom(mp_reader_t *reader, size_t len);
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.codespell]
 count = ""
 ignore-regex = '\b[A-Z]{3}\b'
-ignore-words-list = "ans,asend,deques,dout,extint,hsi,iput,mis,numer,shft,synopsys,technic,ure"
+ignore-words-list = "ans,asend,deques,dout,emac,extint,hsi,iput,mis,numer,shft,synopsys,technic,ure"
 quiet-level = 3
 skip = """
 */build*,\

Original file line number	Diff line number	Diff line change
`@@ -327,7 +327,7 @@ static void eth_gpio_init(const iomux_table_t iomux_table[], size_t iomux_table_`
`327`	`327`	`}`
`328`	`328`	`}`
`329`	`329`
`330`		`-// eth_phy_init: Initilaize the PHY interface`
	`330`	`+// eth_phy_init: Initialize the PHY interface`
`331`	`331`	`static void eth_phy_init(phy_handle_t phyHandle, phy_config_t phy_config,`
`332`	`332`	`phy_speed_t speed, phy_duplex_t duplex, uint32_t phy_settle_time) {`
`333`	`333`