Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to point to public version of Silabs' coding standard #36

Merged
merged 1 commit into from
Feb 17, 2025
Merged

Update README.md to point to public version of Silabs' coding standard #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is a code formatter tool that helps ensure consistent coding style and dete
- Automatically fixes end-of-file issues.
- Removes trailing whitespace from lines.
- Identifies and suggests fixes for common spelling errors using [codespell](https://github.com/codespell-project/codespell).
- Formats code according to specified [Uncrustify](https://github.com/uncrustify/uncrustify) rules base on [Silabs's coding standard](https://stash.silabs.com/projects/WMN_DOCS/repos/docs_misc/browse/software/standards/coding-standard.md)
- Formats code according to specified [Uncrustify](https://github.com/uncrustify/uncrustify) rules base on [Silabs's coding standard](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md)
- Checks for identifiers naming style mismatch of function, definition, struct, variable using [clang-tidy](https://releases.llvm.org/14.0.0/tools/clang/tools/extra/docs/clang-tidy/index.htmlextensible)
- Checks code for potential errors and style issues using [cppcheck](https://cppcheck.sourceforge.io/).

Expand Down Expand Up @@ -124,11 +124,9 @@ This is a sample line that should be excluded.

### Uncrustify

Automatic source code formatting follows [Silabs's coding standard](https://stash.silabs.com/projects/WMN_DOCS/repos/docs_misc/browse/software/standards/coding-standard.md)
Automatic source code formatting follows [Silabs's coding standard](https://github.com/SiliconLabsSoftware/agreements-and-guidelines/blob/main/coding_standard.md)
The Uncrustify configuration file is located at [/tools/uncrustify.cfg](./tools/uncrustify.cfg).

Base on the repo [/projects/WMN_TOOLS/repos/scripts/browse/uncrustify](https://stash.silabs.com/projects/WMN_TOOLS/repos/scripts/browse/uncrustify)


### Clang-Tidy

Expand Down