Feat/add codespell checks for local development and CI/CD #1346
Conversation
WalkthroughAdds a Codespell configuration and integrates codespell into pre-commit and CI workflows; applies multiple documentation, CONTRIBUTING, and test README typo fixes across docs and guidance files. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer (local)
participant PreCommit as pre-commit hook
participant Codespell as codespell
participant CI as GitHub Actions (pre-commit job)
Dev->>PreCommit: git commit / pre-commit run
PreCommit->>Codespell: run using .codespellrc (filtered files)
alt spelling issues found
Codespell-->>PreCommit: apply fixes or report
PreCommit-->>Dev: commit blocked / amended
else no issues
Codespell-->>PreCommit: pass
PreCommit-->>Dev: commit proceeds
end
Note over CI, Codespell: CI job installs codespell and runs same checks on PR changes
CI->>Codespell: install & run
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 32
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd (2)
13312-13334: Fix typo: “dout” (data-out) phase, not “doubt”.Both FDOUT descriptions introduce the misspelling “doubt phase apply…”. The SPI mem docs refer to the DOUT (data-out) phase, so we should keep “dout” and adjust the grammar. Otherwise we’re exchanging one typo for another.
- <description>For SPI0 flash, doubt phase apply 2 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_dio.</description> + <description>For SPI0 flash, dout phase applies 2 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_dio.</description> @@ - <description>For SPI0 flash, doubt phase apply 4 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_qio.</description> + <description>For SPI0 flash, dout phase applies 4 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_qio.</description>
14178-14200: Same typo for SPI1 FDOUT descriptions.The SPI1 FDOUT entries still say “doubt phase apply…”. Please align them with the SPI0 wording after fixing it to “dout phase applies…”.
- <description>For SPI1, doubt phase apply 2 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_dio.</description> + <description>For SPI1, dout phase applies 2 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_dio.</description> @@ - <description>For SPI1, doubt phase apply 4 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_qio.</description> + <description>For SPI1, dout phase applies 4 signals. 1: enable 0: disable. The bit is the same with spi_mem_fread_qio.</description>
🧹 Nitpick comments (5)
tests/com.espressif.idf.ui.test/README.md (2)
69-69: Minor: Consider tightening the phrasing for "prior to".The phrase "prior to eclipse 2021-06" uses "prior to," which static analysis suggests might be wordier than necessary. Consider shortening to "before eclipse 2021-06" for more concise documentation.
80-80: Minor: Add hyphen for consistency with compound modifier.Line 80 mentions "drop down" in the context of a UI element. Per grammar conventions, compound adjectives should be hyphenated:
drop-downordrop down(when used as a noun). Additionally, "UI thread" should likely beUI-threadfor consistency with compound modifier rules.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java (1)
60-60: Consider using type-safe empty list.The raw type
Collections.EMPTY_LISTcan be replaced with the parameterizedCollections.emptyList()for better type safety and to avoid unchecked warnings.Apply this diff:
- return Collections.EMPTY_LIST; + return Collections.emptyList();bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java (1)
416-425: LGTM! Spelling correction applied correctly.The parameter name typo has been fixed and the corrected
directoryparameter is used consistently in the implementation. The method logic is sound with proper resource management via try-with-resources.Optional enhancement: Consider adding a check to ensure the parent directory exists before attempting to create the file, as
FileWriterwill throw an exception if the directory doesn't exist:public static File createFileWithContentsInDirectory(String fileName, String content, String directory) throws IOException { java.nio.file.Path directoryPath = java.nio.file.Paths.get(directory); + if (!Files.exists(directoryPath)) + { + Files.createDirectories(directoryPath); + } java.nio.file.Path filePath = directoryPath.resolve(fileName); try (FileWriter writer = new FileWriter(filePath.toFile())) { writer.write(content); } return filePath.toFile(); }docs_readme/OpenOCD Debugging.md (1)
46-46: Wrap the bare URL in angle brackets.The bare URL triggers a markdown linting warning. According to markdown best practices, URLs should be wrapped in angle brackets.
Apply this diff:
-> **NOTE:** Update the OpenOCD Config options based on the esp board you've chosen. Please check this here https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1 +> **NOTE:** Update the OpenOCD Config options based on the esp board you've chosen. Please check this here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (52)
.codespellrc(1 hunks).github/workflows/pre-commit.yml(1 hunks).pre-commit-config.yaml(1 hunks)CONTRIBUTING.md(2 hunks)bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd(2 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java(4 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java(2 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd(41 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd(26 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd(24 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd(4 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd(198 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd(187 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd(105 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd(12 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s3.svd(100 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java(1 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java(1 hunks)bundles/com.espressif.idf.sdk.config.ui/plugin.xml(1 hunks)bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java(1 hunks)bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java(1 hunks)bundles/com.espressif.idf.ui/plugin.xml(3 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java(2 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java(1 hunks)docs/en/openocddebugging.rst(1 hunks)docs_readme/Espressif-IDE-Windows-Installer.md(1 hunks)docs_readme/JTAG Flashing.md(1 hunks)docs_readme/MissingToolsManualPathUpdateGuide.md(1 hunks)docs_readme/OpenOCD Debugging.md(1 hunks)releng/com.espressif.idf.product/build.properties(1 hunks)releng/com.espressif.idf.product/idf.product(1 hunks)releng/ide-dmg-builder/create-dmg/create-dmg(1 hunks)tests/com.espressif.idf.core.test/src/com/espressif/idf/core/test/IDFVersionReaderTest.java(2 hunks)tests/com.espressif.idf.ui.test/README.md(3 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/IDFProjectLspCdtFunctionalityTest.java(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectClangFilesTest.java(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSBOMTest.java(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSDKconfigTest.java(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectTest.java(2 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java(3 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-27T18:07:42.470Z
Learnt from: sigmaaa
Repo: espressif/idf-eclipse-plugin PR: 1339
File: bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/nvs/handlers/NvsEditorHandler.java:27-34
Timestamp: 2025-10-27T18:07:42.470Z
Learning: In the file bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/nvs/handlers/NvsEditorHandler.java, the NvsEditorHandler is tied to a project explorer right-click command, so EclipseUtil.getSelectedProjectInExplorer() will never return null due to the command's enablement conditions.
Applied to files:
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSDKconfigTest.java
🧬 Code graph analysis (2)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
Logger(21-137)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
Logger(21-137)
🪛 LanguageTool
tests/com.espressif.idf.ui.test/README.md
[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SWTBot Runner config in eclipse for me prior to eclipse 2021-06 always gave issues duri...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~80-~80: Use a hyphen to join words.
Context: ... JUnit4 from the Test runner: drop down. Also make sure that `Run in UI thr...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs_readme/OpenOCD Debugging.md
46-46: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build_macos
🔇 Additional comments (45)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java (1)
29-29: ✓ Spelling correction in JavaDoc is accurate.The typo fix ("registred" → "registered") correctly improves the documentation clarity without affecting any code behavior or logic.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties (1)
10-10: Correct typo in user-facing message.The change corrects an English contraction error: "Could't" → "Couldn't". This improves the clarity and professionalism of the error message displayed to end users. The fix aligns with the PR's codespell-driven typo correction initiative.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java (1)
22-22: Straightforward typo fix in documentation.The spelling correction from "errros" to "errors" in the JavaDoc is accurate and aligns with the PR objective. No functional code is affected.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java (1)
497-497: LGTM!Straightforward typo fix in a log message with no functional impact. The correction improves logging clarity during IDF version detection.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
56-58: Typo correction in exception variable name—LGTM!The exception variable is corrected from the misspelled
execptiontoexception, with the Logger.log call properly updated to use the corrected name. The error handling pattern is sound, and the Logger.log(Exception e) overload is appropriate per the Logger class API.bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd (1)
9-9: Documentation typo corrections look good.These straightforward corrections ("patten" → "pattern" on line 9, "exmaple" → "example" on line 45) improve documentation accuracy with no impact to schema logic or behavior.
Also applies to: 45-45
tests/com.espressif.idf.ui.test/README.md (1)
27-27: Good typo fix in documentation example.The correction from
exectuablestoexecutablesimproves documentation clarity and aligns with the codespell effort.bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd (1)
11344-45451: Documentation-only corrections across all register field descriptions.This file contains 41 comprehensive corrections to register field description text in the SVD file. All changes are purely documentation improvements with no impact on register semantics, bit offsets, widths, or access controls. Corrections include:
- Typo fixes: "weather" → "whether", "sendding" → "sending", "Regisger" → "Register", "thee" → "the", "then" → "than"
- Grammar and punctuation improvements: "lower then" → "lower than", spacing normalization, sentence punctuation
- Non-ASCII character standardization (Ó0Ó sequences in TO_GPIO descriptions)
- Formatting clarity in multi-line descriptions (e.g., DDR, RXFIFO_CNT, TXFIFO_CNT)
All changes align with the PR objective to run codespell and fix existing spelling/grammar issues across the repository.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java (1)
722-722: LGTM! Typo correction improves code quality.The spelling correction from "visiblity" to "visibility" in the trace log message is appropriate and aligns with the PR's objective to fix typos across the codebase.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java (1)
128-129: LGTM! Comment clarity improved.The comment accurately explains that the ModifyListener (lines 115-126) is triggered both programmatically and by user input, while the KeyListener below (lines 130-137) only responds to user keystrokes. The merge and spelling corrections enhance readability.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java (1)
39-39: LGTM! Typo fix in constant name.The correction from
ASTERIKtoASTERISKfixes the spelling error while maintaining identical behavior. The updated constant name is used consistently at line 81.Also applies to: 81-81
bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java (1)
65-65: LGTM! Critical typo fix.The method call is now correctly spelled as
destroy(), aligning with the corrected method name inJsonConfigServerRunnable.java. This fix resolves what would have been a compilation error.bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java (1)
55-55: LGTM! Method name typo corrected.The public method name is now correctly spelled as
destroy(), fixing the typo and ensuring consistency with the caller inJsonConfigServer.java. The method logic remains unchanged.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java (1)
83-83: LGTM! Typo corrected in error message.The spelling correction from "Eclispe" to "Eclipse" improves the user-facing error message.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java (1)
41-41: LGTM! Internal field corrected while preserving public API.The internal field name has been corrected from
licesnsetolicense, while the public getter/setter method names (getLicesnse/setLicesnse) remain unchanged. This approach maintains backward compatibility for any existing consumers of this API or JSON deserialization logic, while cleaning up the internal implementation.Also applies to: 117-125, 244-244, 257-257
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java (1)
57-58: LGTM! Typo corrections applied consistently.All occurrences of the misspelled
identifer()method have been corrected toidentifier()across the LSP preference key usage. The changes are consistent and correct.Also applies to: 70-70, 76-76, 82-82
bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java (1)
23-24: LGTM! Consistent API corrections throughout.The misspelled
identifer()method calls have been corrected toidentifier()across all usage points in this file, including the predefined metadata references and the custom wrapper method.Also applies to: 26-26, 51-51
bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java (1)
19-21: LGTM! API corrections match the pattern in related files.The
identifer()method calls have been corrected toidentifier()consistently throughout this file, matching the same corrections applied inIDFClangdMetadataDefaults.javaandLspService.java.Also applies to: 36-36
releng/com.espressif.idf.product/idf.product (1)
30-33: Critical path mismatch: icon files are in "laucher/" but the product file references "launcher/"The icon files are actually located at
releng/com.espressif.idf.product/laucher/(with the original typo), but the.productfile now referenceslauncher/(corrected spelling). This mismatch means the launcher will fail to load the icons—the changes don't fix the problem, they introduce a breaking defect.To resolve this, either:
- Rename the directory and all references:
laucher/→launcher/- Or revert the
.productfile paths back tolaucher/Likely an incorrect or invalid review comment.
docs_readme/MissingToolsManualPathUpdateGuide.md (1)
6-6: Correct spelling in documentation link.The typo fix ("vist" → "visit") is accurate and improves documentation clarity.
docs_readme/Espressif-IDE-Windows-Installer.md (1)
16-16: Fix spelling in installer documentation.The typo correction ("direclty" → "directly") improves documentation accuracy.
docs_readme/JTAG Flashing.md (1)
31-31: Fix spelling in OpenOCD documentation.The typo correction ("scipts" → "scripts") is accurate and improves technical documentation.
releng/ide-dmg-builder/create-dmg/create-dmg (1)
286-286: Correct spelling in script comment.The typo fix ("soruces" → "sources") in the comment improves code clarity.
bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java (1)
305-305: Fix spelling in terminal configuration comment.The typo corrections ("Avoding" → "Avoiding" and "enviroment" → "environment") improve comment clarity.
bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java (1)
234-234: Correct spelling in process factory comment.The typo fix ("overrideable" → "overridable") uses the standard spelling for this term.
CONTRIBUTING.md (1)
32-32: Improve documentation clarity with punctuation and wording refinements.The corrections improve consistency and readability:
- Line 32: "doubleclick" → "double-click" (proper compound modifier hyphenation)
- Line 34: Clarified text about Maven Plugin Connectors handling
- Line 38: Clarified Tycho plugin management step
- Line 53: Enhanced capitalization in functional test guidance
Also applies to: 34-34, 38-38, 53-53
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties (1)
35-35: Fix spelling in user-facing error message.The typo correction ("doens't" → "doesn't") ensures proper grammar in user-visible dialog messages.
.codespellrc (1)
4-4: Consider the implications of auto-fixing in CI.The
write-changes = truesetting automatically modifies files when spelling errors are detected. While convenient for local development, this may cause unexpected file modifications in CI/CD environments.Verify that the CI workflow behavior aligns with your expectations. If codespell runs in CI and finds errors, should it:
- Auto-fix and require developers to pull changes, or
- Only report errors without modifying files?
For option 2, consider setting
write-changes = falseor removing this line (defaults to false).docs/en/openocddebugging.rst (1)
60-60: LGTM!Correct spelling fix from "choosen" to "chosen".
bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings (1)
23-23: LGTM!Correct spelling fix from "automaticaly" to "automatically".
.github/workflows/pre-commit.yml (1)
25-30: Good addition of codespell checks in CI.The workflow correctly installs and runs codespell separately from the pre-commit hooks. This dual approach (CI workflow + pre-commit hook) ensures spelling errors are caught even if developers skip local pre-commit checks.
.pre-commit-config.yaml (1)
14-19: LGTM!The codespell hook is properly configured with the correct version, stage, and configuration file reference.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd (4)
4622-4627: Spelling correction in SW_XON_INT_RAW description: "receivies" → "receives"Line 4623 corrects the field description from an apparent typo. The description now accurately states the receiver behavior for the Xon flow-control character. This is a minor documentation fix with no functional impact.
4777-4782: Spelling correction in TX_BRK_IDLE_DONE_INT_ST description.Line 4778 corrects the description text. The change improves clarity in the status register documentation for transmitter idle state, aiding developers using this hardware definition in IDEs.
5207-5212: Spelling correction in TXD_BRK field description: "enbale" → "enable"Line 5208 corrects a typo in the transmitter break control field description within the CONF0_SYNC register. The description now correctly states the field enables the transmitter to send NULL characters. This is a documentation-only fix.
5724-5729: Spelling correction in RX_TOUT_EN description: "enble" → "enable"Line 5725 corrects a typo in the receive timeout enable field description within the TOUT_CONF_SYNC register. The description now properly states this bit enables the receiver's timeout function. This is a documentation-only fix.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd (2)
1640-53938: Documentation improvements look good overall.The spelling and grammar corrections throughout this SVD file improve the quality of hardware register documentation. All changes are text-only and don't affect any functional behavior.
12569-12569: This review comment is incorrect—the flagged line was not modified in this PR.The SVD file was not changed by the current pull request. Line 12569 with the phrase "stop disable output" is pre-existing text that predates this PR. Review comments should address only changes introduced by the PR, not pre-existing issues in unchanged files.
Likely an incorrect or invalid review comment.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd (2)
3754-3754: All description text corrections are legitimate typo/grammar fixes.The numerous corrections to field descriptions across hunks 1-23 and 25-105 (such as "caculatrion" → "calculation", "mean not" → "mean", "respeated" → "repeated", "respeat" → "repeat", etc.) appear to be genuine spelling and clarity improvements. These are documentation-only changes with no functional impact on register behavior or software logic.
Also applies to: 3938-3938, 4199-4199, 4230-4230, 4261-4261, 4276-4276, 6206-6206, 7160-7162, 7760-7760, 7766-7766, 8077-8077, 8091-8091, 8149-8149, 8163-8163
30644-30645: No breaking changes detected—the field name correction is safe to proceed.The SVD processing uses dynamic XML parsing via Eclipse embedCDT's framework (TabSvdTarget.java and SvdPathResolver.java), which reads field names from XML elements at runtime rather than hard-coding them. No code references the old "PROTOCAL" field name, and SVD tools will correctly recognize the "PROTOCOL" identifier when parsing the XML file.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd (1)
34293-34293: Clarify unclear wording: "USB pad one in test".This description is unclear. Based on the field name
USB_OE(likely "output enable"), consider revising to something more descriptive like:
- "USB pad output enable test mode"
- "USB pad output enable in test"
Please verify the intended meaning against the hardware reference manual or original documentation.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd (2)
291-297: Documentation-only corrections with no functional impact.All changes in this file are textual corrections to register and field descriptions in the CMSIS-SVD hardware definition. These purely documentation updates improve clarity without affecting the actual hardware peripheral definitions or any functional behavior. Given the codespell focus of this PR, these appear to be legitimate spelling/grammar fixes.
Also applies to: 1355-1361, 23155-23161, 23318-23324, 27449-27453, 28496-28500, 32438-32442, 32720-32724, 46442-46446
23447-23447: Verify DC-DC converter description phrasing.The descriptions in lines 23447, 23454, and 23461 use abbreviated terms ("FPD" and "FPU"). While these may be intentional abbreviations for "Force Power Down" and "Force Power Up," confirm that the corrected phrasing aligns with the technical documentation or datasheet conventions for these registers.
Also applies to: 23454-23454, 23461-23461, 23468-23468
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd (2)
68257-68257: Verify semantic correctness: "maximum" vs register name MIN_CNT.The description states "maximum duration time" but the register name is MIN_CNT, suggesting this should be "minimum duration time" instead.
70164-70164: Clarify unclear grammar: "USB pad one in test".The phrase "USB pad one in test" is grammatically unclear. This might need to be "USB pad output enable in test" or similar, depending on the hardware functionality.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd
Outdated
Show resolved
Hide resolved
...t/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSBOMTest.java
Show resolved
Hide resolved
.../com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSDKconfigTest.java
Outdated
Show resolved
Hide resolved
....test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectTest.java
Outdated
Show resolved
Hide resolved
....test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectTest.java
Show resolved
Hide resolved
...om.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java
Show resolved
Hide resolved
Shen7436
force-pushed
the
feat/add_codespell_check
branch
from
aef702f to
126fe09
Compare
There was a problem hiding this comment.
Actionable comments posted: 18
♻️ Duplicate comments (20)
tests/com.espressif.idf.core.test/src/com/espressif/idf/core/test/IDFVersionReaderTest.java (2)
15-15: Fix invalid import statement - compilation error.The import statement
import org.junit.jupiter.api.after all;contains spaces and incorrect casing, which is invalid Java syntax and will cause a compilation error.Apply this diff:
-import org.junit.jupiter.api.after all; +import org.junit.jupiter.api.AfterAll;
40-40: Fix invalid annotation - compilation error.The annotation
@after allcontains spaces and incorrect casing, which is invalid Java syntax and will prevent compilation and test execution.Apply this diff:
- @after all + @AfterAll.codespellrc (1)
3-3: Fix formatting in ignore-words-list.The
ignore-words-listhas two formatting issues:
- Space after
OT,may causehartto be interpreted ashart(with leading space), preventing proper matching.- Trailing comma at the end of the list may cause parsing issues depending on codespell's implementation.
Apply this diff:
-ignore-words-list = laf,OT, hart,EHEN,targetIn,dout,DOUT,oen,OEN,EMAC,emac,doubleClick, +ignore-words-list = laf,OT,hart,EHEN,targetIn,dout,DOUT,oen,OEN,EMAC,emac,doubleClickbundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd (2)
30644-30645: Fix remaining typo in description: "protoocl" should be "protocol".The field name was corrected to
PROTOCOL, but the description still contains a typo: "protoocl" should be "protocol".Apply this diff to fix the description:
- <description>this bit configures yuv protoocl, 0: bt.601, 1: bt.709</description> + <description>this bit configures yuv protocol, 0: bt.601, 1: bt.709</description>
97435-97443: Inconsistent field naming: These fields still use "PROTOCAL" while line 30644 was corrected to "PROTOCOL".The field
PROTOCOLat line 30644 was corrected, but these related color protocol configuration fields still use the "PROTOCAL" spelling:
YUV2RGB_PROTOCAL(line 97435)RGB2YUV_PROTOCAL(line 97443)For consistency, either all three should use
PROTOCOLor there's a specific reason to keep these with the original spelling.bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd (7)
12317-12317: Previous issue not addressed: confusing "stop disable" wording.This line still contains the grammatically unclear phrase "stop disable output BCK signal" that was flagged in a previous review. It should read "stop output" instead.
16974-16974: Previous issue not addressed: missing space before "(default)".This line still lacks a space before the parenthetical "(default)" as flagged in a previous review. It should read "without acceleration (default)".
17849-17856: Previous issues not addressed: typo "gitch" and inconsistent text.These lines still contain issues flagged in a previous review:
- Line 17849: "gitch" should be "glitch"
- Line 17856: "cal end" text was noted as potentially inconsistent with similar fields
19856-19856: Previous issue not addressed: missing "to" in phrase.This line still has the grammar issue flagged in a previous review. It should read "cycles to wait to return to normal xtal 32k" (adding "to" before "normal").
20017-20017: Previous issue not addressed: typo "gitch".This line still contains "gitch" which should be "glitch" as flagged in a previous review.
31886-31886: Previous issue not addressed: extra space between "to" and "send".This line still contains a double space between "to" and "send" as flagged in a previous review. It should be a single space.
32109-32109: Previous issue not addressed: extra space between "stores" and "the".This line still contains a double space between "stores" and "the" as flagged in a previous review. It should be a single space.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd (6)
2450-2450: Fix typo in LR_ADDR description.The word “gloable” is still present; please update it to “global”.
- <description>gloable lr address register</description> + <description>global lr address register</description>
2465-2465: Fix typo in LR_VALUE description.This description also keeps “gloable”; it should read “global”.
- <description>gloable lr value register</description> + <description>global lr value register</description>
4047-4047: Correct the “caculatrion” typo.Please change “caculatrion” to “calculation” to fix the spelling.
- <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the caculatrion is done.</description> + <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the calculation is done.</description>
20159-20159: Clarify “stop disable output” phrasing.“stop disable output” is confusing; please rewrite to describe the action clearly (e.g., “stop output of BCK and WS signals”).
- <description>Set this bit to stop disable output BCK signal and WS signal when tx FIFO is empty</description> + <description>Set this bit to stop output of BCK and WS signals when TX FIFO is empty.</description>
33207-33207: Remove the double space.There’s still a double space between “to” and “send”; reduce it to a single space.
- <description>Set this bit to enable transmitter to send NULL when the process of sending data is done.</description> + <description>Set this bit to enable transmitter to send NULL when the process of sending data is done.</description>
40811-40811: Fix typo “registe10”.Please spell out “register10” correctly.
- <description>Otp debugger block4 data registe10.</description> + <description>Otp debugger block4 data register10.</description>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd (1)
27645-27645: Fix typo in register description.This is the same issue flagged in a previous review. The description contains "registe10" which should be "register10" to match the pattern used in all other register descriptions.
Apply this diff to fix the typo:
- <description>Otp debugger block4 data registe10.</description> + <description>Otp debugger block4 data register10.</description>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s3.svd (1)
47306-47312: Restore SPI state descriptions (“read”/“DOUT” wording).The SPI state-machine text now says “red data state(DIN)” and “write data state(DOUBT)”. The hardware docs use “read data state (DIN)” and “write data state (DOUT)”. Please revert both occurrences.
Apply this diff:
- <description>The status of SPI0 state machine. 0: idle state(IDLE), 1: preparation state(PREP), 2: send command state(CMD), 3: send address state(ADDR), 4: red data state(DIN), 5:write data state(DOUBT), 6: wait state(DUMMY), 7: done state(DONE).</description> + <description>The status of SPI0 state machine. 0: idle state(IDLE), 1: preparation state(PREP), 2: send command state(CMD), 3: send address state(ADDR), 4: read data state(DIN), 5: write data state(DOUT), 6: wait state(DUMMY), 7: done state(DONE).</description>Apply the same correction to the SPI1 description a few lines below.
Also applies to: 49069-49075
🧹 Nitpick comments (2)
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd (1)
26144-26144: Consider adding "clock" for consistency.For better consistency, the phrase "equal to system" should read "equal to system clock" to match the second part of the sentence which says "divided from system clock".
Apply this diff:
- <description>In the master mode 1: spi_clk is equal to system 0: spi_clk is divided from system clock. Can be configured in CONF state.</description> + <description>In the master mode 1: spi_clk is equal to system clock 0: spi_clk is divided from system clock. Can be configured in CONF state.</description>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd (1)
41662-41662: Improve clarity in register descriptions.The descriptions state "equal to system" which is incomplete. They should specify "equal to system clock" for clarity.
Apply this diff to improve clarity:
- <description>For SPI0 external RAM interface, 1: spi_mem_clk is equal to system 0: spi_mem_clk is divided from system clock.</description> + <description>For SPI0 external RAM interface, 1: spi_mem_clk is equal to system clock 0: spi_mem_clk is divided from system clock.</description>And:
- <description>In the master mode 1: spi_clk is equal to system 0: spi_clk is divided from system clock. Can be configured in CONF state.</description> + <description>In the master mode 1: spi_clk is equal to system clock 0: spi_clk is divided from system clock. Can be configured in CONF state.</description>Also applies to: 45155-45155
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (46)
.codespellrc(1 hunks).github/workflows/pre-commit.yml(1 hunks).pre-commit-config.yaml(1 hunks)CONTRIBUTING.md(2 hunks)bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd(2 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java(4 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java(2 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd(40 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd(22 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd(19 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd(4 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd(190 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd(179 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd(93 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd(11 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s3.svd(83 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java(1 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java(1 hunks)bundles/com.espressif.idf.sdk.config.ui/plugin.xml(1 hunks)bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java(1 hunks)bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java(1 hunks)bundles/com.espressif.idf.ui/plugin.xml(3 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java(2 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java(1 hunks)docs/en/openocddebugging.rst(1 hunks)docs_readme/Espressif-IDE-Windows-Installer.md(1 hunks)docs_readme/JTAG Flashing.md(1 hunks)docs_readme/MissingToolsManualPathUpdateGuide.md(1 hunks)docs_readme/OpenOCD Debugging.md(1 hunks)releng/com.espressif.idf.product/build.properties(1 hunks)releng/com.espressif.idf.product/idf.product(1 hunks)releng/ide-dmg-builder/create-dmg/create-dmg(1 hunks)tests/com.espressif.idf.core.test/src/com/espressif/idf/core/test/IDFVersionReaderTest.java(2 hunks)tests/com.espressif.idf.ui.test/README.md(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- bundles/com.espressif.idf.sdk.config.ui/plugin.xml
🚧 Files skipped from review as they are similar to previous changes (26)
- bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd
- CONTRIBUTING.md
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java
- bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings
- releng/ide-dmg-builder/create-dmg/create-dmg
- .pre-commit-config.yaml
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java
- docs_readme/JTAG Flashing.md
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties
- docs_readme/MissingToolsManualPathUpdateGuide.md
- bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java
- bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java
- bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java
- bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
- releng/com.espressif.idf.product/idf.product
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java
- bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java
- bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java
🧰 Additional context used
🧬 Code graph analysis (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
Logger(21-137)
🪛 LanguageTool
tests/com.espressif.idf.ui.test/README.md
[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SWTBot Runner config in eclipse for me prior to eclipse 2021-06 always gave issues duri...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~80-~80: Use a hyphen to join words.
Context: ... JUnit4 from the Test runner: drop down. Also make sure that `Run in UI thr...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs_readme/OpenOCD Debugging.md
46-46: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (25)
docs_readme/Espressif-IDE-Windows-Installer.md (1)
16-16: Typo corrected: "direclty" → "directly".The spelling fix on line 16 is correct and improves documentation clarity.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java (1)
83-83: Good catch on the typo fix.The correction from "Eclispe" to "Eclipse" improves the quality of the error message. This is exactly the kind of issue that codespell is designed to catch.
bundles/com.espressif.idf.ui/plugin.xml (1)
83-85: Separator identifier spelling corrections are complete and consistent across the codebase.The verification confirms all three separator identifiers have been successfully corrected from
seperatortoseparator. No instances of the misspelled version remain in the codebase, and references in other plugin.xml files (includingbundles/com.espressif.idf.sdk.config.ui/plugin.xml) are properly aligned. The changes are valid and complete.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
56-58: LGTM! Typo fix improves code quality.The correction of the variable name from
execptiontoexceptionis appropriate and aligns with standard Java naming conventions. The Logger.log call is correctly updated to use the corrected variable name.docs/en/openocddebugging.rst (1)
59-60: Proper RST link formatting applied.The URL on line 60 is correctly wrapped in ReStructuredText inline link syntax (
`text <url>`_), following RST best practices. This aligns well with the documentation standard for this file.bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java (1)
416-418: Parameter name typo fix is correct and safe—verified single call site uses positional arguments.The correction from "direcotry" to "directory" on lines 416 and 418 improves code quality and readability. Verification found one call site in
BugReportGenerator.java(line 237), which uses positional arguments and is unaffected by the parameter name change.tests/com.espressif.idf.ui.test/README.md (1)
27-27: Good catch on the package path typo fix.The correction from
com.espressif.idf.tests.exectuables.casestocom.espressif.idf.tests.executables.casesis accurate and improves clarity for developers following this guide..github/workflows/pre-commit.yml (1)
25-29: LGTM! Codespell integration is correct.The codespell installation and execution steps are properly configured. Running codespell explicitly in CI ensures spell checking occurs even if developers bypass pre-commit hooks locally, which is a good practice for CI/CD pipelines.
bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java (2)
57-57: Spelling correction looks good.The method name has been correctly updated from
identifer()toidentifier().
57-82: All occurrences of theidentifer()typo have been successfully corrected.Verification confirms:
- LspService.java lines 57, 70, 76, 82 all show the correct
.identifier()spelling- No remaining instances of the misspelled
identiferexist in the codebaseThe changes are complete and correct.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd (6)
3754-3754: LGTM: Documentation improvements enhance clarity.These description text corrections fix typos and improve grammar across register and field descriptions, making the SVD file more readable and professional.
Also applies to: 3938-3938, 4199-4199, 4230-4230, 4261-4261, 4276-4276, 4573-4573, 4757-4757, 5018-5018, 5049-5049, 5080-5080, 5095-5095, 6206-6206, 7162-7162, 7760-7766, 7775-7781, 8077-8077, 8091-8091, 8149-8149, 8163-8163, 12831-12838, 12859-12859, 14871-14871
33556-33556: LGTM: Consistent typo corrections across configuration registers.These changes fix spelling errors and improve description consistency across various peripheral configuration registers (ECC, ECDSA, USB, eFuse, SDIO, interrupts, probe selection, and bitscrambler).
Also applies to: 33584-33584, 33833-33833, 33930-33930, 33945-33945, 34676-34683, 36612-36612, 39884-39890, 52036-52036, 52051-52051, 52066-52066, 52081-52081, 52097-52097, 52301-52322, 52344-52351, 53235-53242, 61033-61033, 64790-64790, 65209-65209
66129-66178: LGTM: Description refinements for ISP, LCD, and UART peripherals.These textual corrections improve the documentation quality for gaussian templates, camera control, AWB configuration, clock enables, and UART interrupt descriptions.
Also applies to: 66194-66194, 68249-68249, 68750-68750, 68816-68816, 68837-68837, 69273-69273, 80322-80322, 86374-86374, 86529-86529, 86959-86959, 87476-87476, 88783-88783
90590-90590: LGTM: Documentation clarity improvements for Parallel IO, PPA, ADC, and SDIO.These changes enhance descriptions for interrupt registers, color key defaults, ADC error handling, and DDR mode configuration with improved grammar and formatting.
Also applies to: 90619-90619, 90648-90648, 90677-90677, 97436-97443, 97861-97875, 104824-104831, 104874-104881, 104924-104931, 104974-104981, 105024-105031, 105074-105081, 107803-107803, 107817-107817, 107831-107831, 107853-107855
108606-108606: LGTM: SPI and SHA register documentation improvements.These corrections improve clarity in SHA memory descriptions and various SPI configuration registers (clock modes, bit ordering, cryption security, interrupt descriptions).
Also applies to: 117867-117867, 118602-118602, 120694-120694, 121069-121069, 122072-122072, 122465-122465, 122509-122509, 124205-124205, 124517-124517, 124561-124561, 126053-126053
127852-127852: LGTM: Trace encoder and UART description refinements.These changes improve documentation for trace memory loop mode, CPU reset/halt handling, UART interrupts, baud rate detection, and USB serial FIFO descriptions.
Also applies to: 127881-127888, 127909-127909, 129438-129438, 129614-129614, 130107-130107, 130708-130708, 130853-130853, 133281-133281
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd (9)
6190-6190: Good typo fix!The correction from "Selectes" to "Selects" is accurate.
19329-19329: Good typo fix!The correction from "disabel" to "disable" is accurate.
20513-20513: Good typo fix!The correction from "verision" to "version" is accurate.
23963-23963: Good typo fix!The correction from "finial" to "final" is accurate.
24086-24086: Description looks correct.The SPI clock mode description is clear and grammatically correct.
26100-26100: Description looks correct.The bit order description is clear and accurate.
31203-31203: Description looks correct.The interrupt description is clear and grammatically correct.
31379-31379: Description looks correct.The status bit description is clear and grammatically correct.
32077-32077: Description looks correct.The enable bit description is clear and grammatically correct.
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
Shen7436
force-pushed
the
feat/add_codespell_check
branch
from
126fe09 to
888b880
Compare
There was a problem hiding this comment.
Actionable comments posted: 16
♻️ Duplicate comments (24)
docs_readme/OpenOCD Debugging.md (1)
46-46: Bare URL still violates MD034 markdown linting rule.While the typo correction from "choosen" to "chosen" is appreciated, the bare URL remains unresolved and continues to violate the MD034 (no-bare-urls) linting rule that was flagged in the previous review. Wrap the URL in markdown link syntax to comply with linting standards.
Apply this diff to fix the bare URL:
- > **NOTE:** Update the OpenOCD Config options based on the esp board you've chosen. Please check this here https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1 + > **NOTE:** Update the OpenOCD Config options based on the esp board you've chosen. Please check [this](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1) for more information.tests/com.espressif.idf.ui.test/README.md (2)
80-80: Hyphenate "drop down" compound adjective.Line 80 still contains the unfixed grammar issue flagged in past reviews. Compound adjectives should be hyphenated.
Apply this diff:
- From the opened screen you can see some settings. First thing to make sure is that you use **JUnit4** from the `Test runner:` drop down. Also make sure that `Run in UI thread` is unchecked. + From the opened screen you can see some settings. First thing to make sure is that you use **JUnit4** from the `Test runner:` drop-down. Also make sure that `Run in UI thread` is unchecked.
69-69: Outstanding spelling and wordiness issues remain unfixed.Line 69 contains two issues already flagged in past reviews that should be addressed:
- "looses focus" → "loses focus" (loses = stops having; looses = releases/sets free)
- "prior to eclipse 2021-06" → "before eclipse 2021-06" (wordiness reduction)
Given that this PR is specifically for adding codespell checks and fixing spelling/typo errors, these should be corrected for consistency.
Apply this diff:
- At times we need to debug the tests and for some issues in the SWTBot API you will get the exception of `WidgetNotFound` during debug which is because the SWTBot is dependent on UI focus a lot and during a test run if you are using the machine and the test instance of eclipse looses focus it gives that exception during debug we have to make sure that breakpoints are properly placed so that during UI interaction the test instance stays in focus. The SWTBot Runner config in eclipse for me prior to eclipse 2021-06 always gave issues during debug so I had to use the JUnit Runner Launch Config. + At times we need to debug the tests and for some issues in the SWTBot API you will get the exception of `WidgetNotFound` during debug which is because the SWTBot is dependent on UI focus a lot and during a test run if you are using the machine and the test instance of eclipse loses focus it gives that exception during debug we have to make sure that breakpoints are properly placed so that during UI interaction the test instance stays in focus. The SWTBot Runner config in eclipse for me before eclipse 2021-06 always gave issues during debug so I had to use the JUnit Runner Launch Config.bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd (5)
2450-2450: Previously identified typo still present: "gloable" should be "global".This typo was flagged in a previous review but has not been corrected.
Apply these diffs:
- <description>gloable lr address register</description> + <description>global lr address register</description>- <description>gloable lr value register</description> + <description>global lr value register</description>Also applies to: 2465-2465
4047-4047: Previously identified typo still present: "caculatrion" should be "calculation".This typo was flagged in a previous review but has not been corrected.
Apply this diff:
- <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the caculatrion is done.</description> + <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the calculation is done.</description>
20159-20159: Previously identified ambiguous wording still present.The phrase "stop disable output BCK signal and WS signal" was flagged in a previous review as confusing.
33207-33207: Previously identified double space still present.The double space between "to" and "send" was flagged in a previous review but has not been corrected. This issue appears at both Line 33207 and Line 67511.
Apply these diffs:
- <description>Set this bit to enable transmitter to send NULL when the process of sending data is done.</description> + <description>Set this bit to enable transmitter to send NULL when the process of sending data is done.</description>Also applies to: 67511-67511
40811-40811: Previously identified typo still present: "registe10" should be "register10".This typo was flagged in a previous review but has not been corrected.
Apply this diff:
- <description>Otp debugger block4 data registe10.</description> + <description>Otp debugger block4 data register10.</description>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd (1)
30644-30645: Fix inconsistent field naming and description typo.This issue was previously flagged but remains unresolved. The field name change from
PROTOCALtoPROTOCOLat line 30644 is inconsistent with related fields at lines 97435 and 97442:
YUV2RGB_PROTOCAL(line 97435)RGB2YUV_PROTOCAL(line 97442)These serve similar color protocol configuration purposes and should follow the same naming convention for consistency.
Additionally, line 30645 contains a typo: "protoocl" should be "protocol".
Apply this diff to fix the description typo:
- <description>this bit configures yuv protoocl, 0: bt.601, 1: bt.709</description> + <description>this bit configures yuv protocol, 0: bt.601, 1: bt.709</description>For the naming inconsistency, either rename all three fields to use
PROTOCOLor provide justification for keeping different spellings. If renaming, also update lines 97435 and 97442:- <name>YUV2RGB_PROTOCAL</name> + <name>YUV2RGB_PROTOCOL</name>- <name>RGB2YUV_PROTOCAL</name> + <name>RGB2YUV_PROTOCOL</name>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd (8)
12317-12317: Clarify “stop disable” phrasing.The sentence is still contradictory (“stop disable”). Please rewrite as “Set this bit to stop outputting the BCK and WS signals when the TX FIFO is empty” (or equivalent).
16974-16974: Insert missing space before(default).The parenthetical needs a preceding space: “…without acceleration (default).”
17849-17849: Fix typo “gitch” → “glitch”.The interrupt description still misspells “glitch.”
17856-17856: Align wording with other BBPLL fields.Drop “end” so it reads “enable bbpll cal interrupt,” matching the other registers.
19856-19856: Restore missing “to”.Please change to “cycles to wait to return to normal xtal 32k.”
20017-20017: Fix typo “gitch” → “glitch”.Same typo persists here for the W1TS field.
31886-31886: Remove double space.There’s still a double space between “to” and “send.”
32109-32109: Remove double space.Please keep a single space between “stores” and “the.”
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd (7)
3959-3959: Fix typo in register description.The description contains "caculatrion" which should be "calculation".
Apply this diff to fix the typo:
- <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the caculatrion is done.</description> + <description>Write 1 to start calculation of ECC Accelerator. This bit will be self-cleared after the calculation is done.</description>
12569-12569: Clarify confusing wording in register description.The phrase "stop disable output BCK signal" contains contradictory verbs. It should be either "stop output" or "disable output", not both.
Apply this diff to clarify the description:
- <description>Set this bit to stop disable output BCK signal and WS signal when tx FIFO is empty</description> + <description>Set this bit to disable output BCK signal and WS signal when tx FIFO is empty</description>
17245-17245: Fix typo in register description.The description contains "slftware" which should be "software".
Apply this diff to fix the typo:
- <description>Select enabling signals of the pad from software and efuse hardware. 1: Select enabling signal from slftware. 0: Select enabling signal from efuse hardware.</description> + <description>Select enabling signals of the pad from software and efuse hardware. 1: Select enabling signal from software. 0: Select enabling signal from efuse hardware.</description>
30425-30425: Fix typo in register description.The description contains "clck-source" which should be "clock-source".
Apply this diff to fix the typo:
- <description>Set as one within (0,1,2) to generate div1(default)/div2/div4 of low-speed clock-source to drive clk_mspi_fast. Only available when the clck-source is a low-speed clock-source such as XTAL/FOSC.</description> + <description>Set as one within (0,1,2) to generate div1(default)/div2/div4 of low-speed clock-source to drive clk_mspi_fast. Only available when the clock-source is a low-speed clock-source such as XTAL/FOSC.</description>
43336-43336: Fix incorrect terminology in register description.The description uses "cryption" which should be "encryption" to use the correct technical term.
Apply this diff to fix the terminology:
- <description>Set the security level of spi mem cryption. 0: Shut off cryption DPA function. 1-7: The bigger the number is, the more secure the cryption is. (Note that the performance of cryption will decrease together with this number increasing)</description> + <description>Set the security level of spi mem encryption. 0: Shut off encryption DPA function. 1-7: The bigger the number is, the more secure the encryption is. (Note that the performance of encryption will decrease together with this number increasing)</description>
51530-51530: Fix contradictory description.The register name is
MIN_CNTbut the description states "maximum duration time". It should be "minimum" to match the register name.Apply this diff to fix the contradiction:
- <description>This register stores the value of the maximum duration time for the high level pulse. It is used in baud rate-detect process.</description> + <description>This register stores the value of the minimum duration time for the high level pulse. It is used in baud rate-detect process.</description>
27645-27645: Fix typo in register description.The description contains a typo: "registe10" should be "register10" to match the pattern used in all other similar register descriptions.
Apply this diff to fix the typo:
- <description>Otp debugger block4 data registe10.</description> + <description>Otp debugger block4 data register10.</description>
🧹 Nitpick comments (2)
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd (1)
60046-60046: Use standard terminology: "cryption" should be "encryption" or "cryptographic".The term "cryption" appears twice in this description but is non-standard. Use "encryption" or "cryptographic" for technical clarity.
Apply this diff:
- <description>Set the security level of spi mem cryption. 0: Shut off cryption DPA function. 1-7: The bigger the number is, the more secure the cryption is. (Note that the performance of cryption will decrease together with this number increasing)</description> + <description>Set the security level of spi mem encryption. 0: Shut off encryption DPA function. 1-7: The bigger the number is, the more secure the encryption is. (Note that the performance of encryption will decrease together with this number increasing)</description>bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd (1)
38094-38094: Use standard capitalization for SHA acronym."Sha" should be "SHA" (all caps) as it's an acronym for Secure Hash Algorithm.
Apply this diff to use standard capitalization:
- <description>Sha H memory which contains intermediate hash or final hash.</description> + <description>SHA H memory which contains intermediate hash or final hash.</description>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (45)
.codespellrc(1 hunks).github/workflows/pre-commit.yml(1 hunks).pre-commit-config.yaml(1 hunks)CONTRIBUTING.md(2 hunks)bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd(2 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java(4 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java(1 hunks)bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java(2 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java(1 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd(40 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd(22 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c3.svd(19 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd(4 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6.svd(190 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd(179 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd(93 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd(11 hunks)bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s3.svd(83 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java(2 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java(1 hunks)bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java(1 hunks)bundles/com.espressif.idf.sdk.config.ui/plugin.xml(1 hunks)bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java(1 hunks)bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java(1 hunks)bundles/com.espressif.idf.ui/plugin.xml(3 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java(2 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java(1 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java(1 hunks)docs/en/openocddebugging.rst(1 hunks)docs_readme/Espressif-IDE-Windows-Installer.md(1 hunks)docs_readme/JTAG Flashing.md(1 hunks)docs_readme/MissingToolsManualPathUpdateGuide.md(1 hunks)docs_readme/OpenOCD Debugging.md(1 hunks)releng/com.espressif.idf.product/build.properties(1 hunks)releng/com.espressif.idf.product/idf.product(1 hunks)releng/ide-dmg-builder/create-dmg/create-dmg(1 hunks)tests/com.espressif.idf.ui.test/README.md(3 hunks)
✅ Files skipped from review due to trivial changes (3)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/src/com/espressif/idf/debug/gdbjtag/openocd/dsf/Launch.java
- docs_readme/MissingToolsManualPathUpdateGuide.md
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s3.svd
🚧 Files skipped from review as they are similar to previous changes (22)
- bundles/com.espressif.idf.debug.gdbjtag.openocd/about.mappings
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c2.svd
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java
- releng/com.espressif.idf.product/idf.product
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java
- .pre-commit-config.yaml
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32c6-lp.svd
- bundles/com.espressif.idf.sdk.config.ui/plugin.xml
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/size/IDFSizeDataManager.java
- releng/ide-dmg-builder/create-dmg/create-dmg
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/wizard/ImportIDFProjectWizardPage.java
- docs_readme/JTAG Flashing.md
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/installcomponents/handler/InstallCommandHandler.java
- .codespellrc
- bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32s2.svd
- bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java
- docs_readme/Espressif-IDE-Windows-Installer.md
- docs/en/openocddebugging.rst
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/messages.properties
- .github/workflows/pre-commit.yml
- bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFClangdMetadataDefaults.java
🧰 Additional context used
🧬 Code graph analysis (2)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
Logger(21-137)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
bundles/com.espressif.idf.core/src/com/espressif/idf/core/logging/Logger.java (1)
Logger(21-137)
🪛 LanguageTool
tests/com.espressif.idf.ui.test/README.md
[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SWTBot Runner config in eclipse for me prior to eclipse 2021-06 always gave issues duri...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[grammar] ~80-~80: Use a hyphen to join words.
Context: ... JUnit4 from the Test runner: drop down. Also make sure that `Run in UI thr...
(QB_NEW_EN_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build_macos
🔇 Additional comments (16)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/handlers/messages.properties (1)
10-10: Good catch on the typo fix.The correction from "Could't" to "Couldn't" is accurate and improves the user-facing message. This is a straightforward and appropriate fix aligned with the PR's goal of systematic typo corrections via codespell.
CONTRIBUTING.md (1)
32-32: Spelling and typography corrections are well-aligned with PR objectives.All typo corrections in CONTRIBUTING.md (lines 32, 34, 38, 53) are accurate and improve documentation clarity:
- "doubleclick" → "double-click" (proper hyphenation)
- "Extention" → "Extension" (correct spelling)
- "extention" → "extension" (correct spelling)
- "Funtional" → "Functional" (correct spelling)
These changes are consistent with the codespell integration effort and enhance the quality of developer-facing documentation.
Also applies to: 34-34, 38-38, 53-53
bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd (2)
9-9: LGTM! Typo fix improves documentation quality.The correction from "patten" to "pattern" fixes a spelling error in the extension point documentation.
45-45: LGTM! Typo fix improves documentation quality.The correction from "exmaple" to "example" fixes a spelling error in the attribute documentation.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/install/IDFDownloadPage.java (1)
497-497: LGTM! Typo corrected in log message.The spelling correction from "commads" to "commands" improves the log message clarity.
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tracing/heaptracing/HeapTracingAnalysisEditor.java (1)
51-59: LGTM! Typo fix is correct.The variable name typo "execption" has been correctly fixed to "exception", and the Logger.log call properly references the corrected variable name.
bundles/com.espressif.idf.sdk.config.ui/src/com/espressif/idf/sdk/config/ui/SDKConfigurationEditor.java (1)
721-722: LGTM! Typo fixed correctly.The spelling correction from "visiblity" to "visibility" improves the trace log message quality.
bundles/com.espressif.idf.terminal.connector/src/com/espressif/idf/terminal/connector/launcher/IDFConsoleLauncherDelegate.java (1)
305-305: LGTM! Typo fix improves comment clarity.The spelling corrections ("Avoding" → "Avoiding" and "enviroment" → "environment") align with the PR's objective to fix typos across the codebase.
bundles/com.espressif.idf.ui/plugin.xml (1)
83-83: Need to verify that these separator identifiers are properly referenced in menu contributions to ensure they're not orphaned:Now I need to verify that menu contributions reference these separator names correctly:
Separator name corrections verified and complete.
The three separator identifiers have been successfully corrected from
com.espressif.idf.espressif.seperator*tocom.espressif.idf.espressif.separator*. The verification confirms:
- No remnants of the old typo names remain in XML or Java files.
- The corrected separator names are consistently defined across all related plugin configuration files.
- All menu wiring references are intact.
These are clean typo fixes with no impact to menu structure or functionality.
tests/com.espressif.idf.ui.test/README.md (1)
27-27: Package name spelling correction looks good.The fix from
exectuablestoexecutablesis accurate and properly aligns with the codespell PR objectives.bundles/com.espressif.idf.lsp/src/com/espressif/idf/lsp/preferences/IDFEditorMetadataDefaults.java (1)
19-37: LGTM! Consistent typo corrections throughout.All corrections from
identifer()toidentifier()are accurate across both thedefinePreferences()method and thewrapWithCustomDefaultValue()helper. The changes maintain consistency with the corrected API.bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java (1)
57-93: All corrections verified and approved.The verification search confirmed no remaining usages of the misspelled
identifer()method exist in the codebase. All four corrections fromidentifer()toidentifier()in lines 57–93 are properly applied and complete.bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServer.java (1)
65-65: LGTM! Typo fix aligns with renamed method.The corrected method call properly invokes the renamed
destroy()method inJsonConfigServerRunnable.bundles/com.espressif.idf.sdk.config.core/src/com/espressif/idf/sdk/config/core/server/JsonConfigServerRunnable.java (1)
55-55: LGTM - typo fix verified and complete.The method rename from
destory()todestroy()has been successfully applied. No references to the old typo remain in the codebase, and all call sites have been updated (including the delegation inJsonConfigServer.java:65and the caller inSDKConfigurationEditor.java:466).bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32p4.svd (1)
3754-3754: Excellent typo corrections in descriptions.The description text corrections throughout this file improve clarity and professionalism. These changes fix various typos including:
- Grammar and article corrections
- Spelling fixes (e.g., "buzy" → "busy", "reigster" → "register", "selec" → "select")
- Improved phrasing for better readability
Since these are documentation-only changes with no impact on field names, register structures, or functional behavior, they're safe improvements.
Also applies to: 3938-3938, 4199-4199, 4230-4230, 4261-4261, 4276-4276, 4573-4573, 4757-4757, 5018-5018, 5049-5049, 5080-5080, 5095-5095, 6206-6206, 7162-7162, 7760-7760, 7766-7766, 7775-7775, 7781-7781, 8077-8077, 8091-8091, 8149-8149, 8163-8163, 12831-12831, 12838-12838, 12859-12859, 14871-14871, 33556-33556, 33584-33584, 33833-33833, 33930-33930, 33945-33945, 34676-34676, 34683-34683, 36612-36612, 39884-39884, 39890-39890, 52036-52036, 52051-52051, 52066-52066, 52081-52081, 52097-52097, 52301-52301, 52308-52308, 52315-52315, 52322-52322, 52344-52344, 52351-52351, 53235-53235, 53242-53242, 61033-61033, 64790-64790, 65209-65209, 66129-66129, 66136-66136, 66143-66143, 66150-66150, 66157-66157, 66164-66164, 66171-66171, 66178-66178, 66194-66194, 68249-68249, 68750-68750, 68816-68816, 68837-68837, 69273-69273, 80322-80322, 86374-86374, 86529-86529, 86959-86959, 87476-87476, 88783-88783, 90590-90590, 90619-90619, 90648-90648, 90677-90677, 97436-97436, 97443-97443, 97861-97861, 97868-97868, 97875-97875, 104824-104824, 104831-104831, 104874-104874, 104881-104881, 104924-104924, 104931-104931, 104974-104974, 104981-104981, 105024-105024, 105031-105031, 105074-105074, 105081-105081, 107803-107803, 107817-107817, 107831-107831, 107853-107855, 108606-108606, 117867-117867, 118602-118602, 120694-120694, 121069-121069, 122072-122072, 122465-122465, 122509-122509, 124205-124205, 124517-124517, 124561-124561, 126053-126053, 127852-127852, 127881-127881, 127888-127888, 127909-127909, 129438-129438, 129614-129614, 130107-130107, 130708-130708, 130853-130853, 133281-133281
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32.svd (1)
43476-43476: Verify semantic consistency: MIN_CNT vs. "maximum duration".The field is named
MIN_CNT(minimum count) but the description states "the value of the maximum duration time". This appears contradictory. Please verify whether:
- The description should say "minimum" instead of "maximum", or
- The field actually stores a maximum value (and naming is historical/contextual)
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
bundles/com.espressif.idf.debug.gdbjtag.openocd/svd/esp32h2.svd
Outdated
Show resolved
Hide resolved
Shen7436
force-pushed
the
feat/add_codespell_check
branch
3 times, most recently
from
3569e2f to
61cbfbd
Compare
Shen7436
force-pushed
the
feat/add_codespell_check
branch
from
73d0458 to
06079f0
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
tests/com.espressif.idf.ui.test/README.md (1)
69-69: Optional wording tweak: “prior to” → “before”.The grammar and spelling in this sentence now look good (“loses focus” is correct). For slightly tighter wording, you could change “prior to eclipse 2021-06” to “before eclipse 2021-06”.
🧹 Nitpick comments (1)
docs_readme/MissingToolsManualPathUpdateGuide.md (1)
6-6: Typo fix looks good; consider cleaning up remaining typos.The link text correction to “visit” is correct. While you’re here, you might also want to fix remaining typos in this file, e.g. “dont” → “don't” (Line 12) and “copeid” → “copied” (Line 29).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
.codespellrc(1 hunks).github/workflows/pre-commit.yml(1 hunks).pre-commit-config.yaml(1 hunks)CONTRIBUTING.md(2 hunks)docs/en/openocddebugging.rst(1 hunks)docs_readme/Espressif-IDE-Windows-Installer.md(1 hunks)docs_readme/JTAG Flashing.md(1 hunks)docs_readme/MissingToolsManualPathUpdateGuide.md(1 hunks)docs_readme/OpenOCD Debugging.md(1 hunks)tests/com.espressif.idf.ui.test/README.md(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (6)
- docs/en/openocddebugging.rst
- docs_readme/JTAG Flashing.md
- docs_readme/Espressif-IDE-Windows-Installer.md
- docs_readme/OpenOCD Debugging.md
- .github/workflows/pre-commit.yml
- .pre-commit-config.yaml
🧰 Additional context used
🪛 LanguageTool
tests/com.espressif.idf.ui.test/README.md
[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SWTBot Runner config in eclipse for me prior to eclipse 2021-06 always gave issues duri...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build_macos
🔇 Additional comments (3)
.codespellrc (1)
1-4: Codespell config looks solid; confirmwrite-changesbehavior is desired.The section, skip pattern, and ignore list all look reasonable, and the previous spacing issue in
ignore-words-listhas been fixed. Just confirm thatwrite-changes = trueis intentional, since it will rewrite files when runningcodespelldirectly (outside pre-commit/CI) rather than only reporting issues.tests/com.espressif.idf.ui.test/README.md (2)
27-27: Package path typo correction is correct.Updating the package to
com.espressif.idf.tests.executables.casesfixes the spelling and better reflects the intended “executables” naming.
80-80: Hyphenation fix looks good.Using “drop-down” as a compound adjective here is correct and matches style guidance.
This PR introduces the following changes:
Summary by CodeRabbit
Chores
Documentation