rt-thread-official/.hooks/readme.md

16 lines
1.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# How to use git hook
## SDK install
Please use cmd `git config --local core.hooksPath .hooks` for git hooks local.
## git hooks使用注意事项
- hooks里面的要安装cppcheck和astyle以及formatting命令行才能使用如果想要去掉某个选项在pre-commit中注释掉相应的命令即可。
- 取消hook选项请使用命令`git config --unset --local core.hooksPath .hooks` 可以取消hook格式化文件
- 这个githook不敲命令是不生效的
- githook会用astyle格式化一些文件这个按照rt-thread coding-style里面的设置来的这里要注意如果之前文件没有经过astlye格式化的话会出现很多修改如果修改过多建议不用astyle进行格式化。
- formatting命令只针对`c|cpp|h` 文件并没有针对文件夹修改等。所以如果有SDK等不希望formatting的文件请先将hooks功能去掉commit之后再考虑使用hooks命令。
- 如果对git的pre-commit不是很熟悉建议可以先不用这个hooks。