simbit18 commented on issue #16264: URL: https://github.com/apache/nuttx/issues/16264#issuecomment-2991379162
Hi, @TimJTi I hope this will help ``` checkpatch-sh is a bash script that make use of nxstyle and codespell tools to format patches and files conform to NuttX coding standard. For example, it has been used in NuttX github action PR check build https://nuttx.apache.org/docs/latest/components/tools/index.html#checkpatch-sh The checkpatch.sh script currently checks these types of files: ************************************* C code ------------------------------------ File: .h, .c Tools required: nxstyle nxstyle: https://nuttx.apache.org/docs/latest/components/tools/index.html#nxstyle-c ************************************* Python ------------------------------------ File: .py Tools required: black isort flake8 -> "pip install black isort flake8" black: An code formatter that automatically formats your Python code. isort: A tool for sorting Python imports in a consistent and organized manner. flake8: A code linting tool that checks your code and identifies potential issues. Use: black <src> ************************************* Rust ------------------------------------ File: .rs Tools required: rustfmt -> "rustup component add rustfmt" rustfmt: A tool for formatting Rust code according to style guidelines ************************************* CMake ------------------------------------ File: CMakeLists.txt, .cmake Tools required: cmake-format -> "pip install cmake-format" Use: cmake-format <src> -o <dst> cmake-format: A tool for formatting Cmake file. ************************************* also check out ************************************* All files ------------------------------------ File: All file Tools required: codespell -> "pip install codespell" cvt2utf -> "pip install cvt2utf" codespell: A tool simple spell checker https://pypi.org/project/codespell/ cvt2utf: A tool converts non-UTF-encoded files to UTF-8 encoding https://github.com/x1angli/cvt2utf ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
