Skip to content

drivers: Fix comment typos — 'register' → 'registered' across drivers.#18985

Merged
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:fix/comment-register-typo
May 28, 2026
Merged

drivers: Fix comment typos — 'register' → 'registered' across drivers.#18985
xiaoxiang781216 merged 1 commit into
apache:masterfrom
Zepp-Hanzj:fix/comment-register-typo

Conversation

@Zepp-Hanzj
Copy link
Copy Markdown
Contributor

Summary

Fix grammatical error in Returned Value documentation comments across 17 driver files. The verb form was missing the past participle ending:

  • successfully registersuccessfully registered (18 occurrences)
  • successfully initializesuccessfully initialized (1 occurrence, ptp_clock_dummy.c)

All changes are in comment blocks only — no functional code is modified.

Affected Files

Subsystem File Fix
i2c drivers/i2c/i2c_driver.c register → registered
i2s drivers/i2s/i2schar.c register → registered
i3c drivers/i3c/i3c_driver.c register → registered
i3c drivers/i3c/master.c register → registered
motor drivers/motor/motor.c register → registered
motor drivers/motor/stepper.c register → registered
rc drivers/rc/lirc_dev.c register → registered
sensors drivers/sensors/gnss_uorb.c register → registered
sensors drivers/sensors/sensor.c register → registered (×2)
spi drivers/spi/spi_driver.c register → registered
timers drivers/timers/ptp_clock.c register → registered
timers drivers/timers/ptp_clock_dummy.c initialize → initialized
video drivers/video/mipidsi/mipi_dsi.h register → registered (×2)
video drivers/video/mipidsi/mipi_dsi_device.c register → registered
video drivers/video/mipidsi/mipi_dsi_device_driver.c register → registered
video drivers/video/mipidsi/mipi_dsi_host.c register → registered
video drivers/video/mipidsi/mipi_dsi_host_driver.c register → registered

Impact

  • Impact on build: NO
  • Impact on hardware: NO
  • Impact on documentation: NO (these are source-code comments, not Sphinx docs)
  • Impact on security: NO
  • Impact on compatibility: NO

Testing

  • checkpatch.sh -g HEAD: All checks pass.
  • All 17 changed files individually pass checkpatch.sh -f.
  • One line wrap applied in mipi_dsi_device.c:1001 to stay within 78-column limit after the longer word.

Self-Check

  • PR title follows NuttX convention
  • Commit body lists all affected files and explains the change
  • Signed-off-by present
  • checkpatch passes
  • Comment-only changes, zero functional impact

Fix grammatical error in Returned Value documentation comments:
  'successfully register' → 'successfully registered'
  'successfully initialize' → 'successfully initialized'

Affected files (17 files, 19 occurrences):
  drivers/i2c/i2c_driver.c
  drivers/i2s/i2schar.c
  drivers/i3c/i3c_driver.c
  drivers/i3c/master.c
  drivers/motor/motor.c
  drivers/motor/stepper.c
  drivers/rc/lirc_dev.c
  drivers/sensors/gnss_uorb.c
  drivers/sensors/sensor.c (2 occurrences)
  drivers/spi/spi_driver.c
  drivers/timers/ptp_clock.c
  drivers/timers/ptp_clock_dummy.c
  drivers/video/mipidsi/mipi_dsi.h (2 occurrences)
  drivers/video/mipidsi/mipi_dsi_device.c
  drivers/video/mipidsi/mipi_dsi_device_driver.c
  drivers/video/mipidsi/mipi_dsi_host.c
  drivers/video/mipidsi/mipi_dsi_host_driver.c

These are all comment-only changes with no functional impact.

Signed-off-by: hanzj <hanzjian@zepp.com>
@github-actions github-actions Bot added Area: Drivers Drivers issues Size: S The size of the change in this PR is small labels May 28, 2026
@xiaoxiang781216 xiaoxiang781216 merged commit 7679bba into apache:master May 28, 2026
41 checks passed
@Zepp-Hanzj Zepp-Hanzj deleted the fix/comment-register-typo branch May 28, 2026 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Drivers Drivers issues Size: S The size of the change in this PR is small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants