Execute script [tugraph_root]/cpplint/git-hooks-init.sh to configure your local git hooks
When run git push, the hook script is automatically triggered to check the cpp source files of this push with cpplint.
Before git push, use cpplint to check the c++ source files involved in this commit.
cpplint is just a python file that has been placed in the code repository, which path is [tugraph_root]/cpplint/cpplint.py.
For example, if you modify the two files [tugraph_root]/src/algo/algo.cpp and [tugraph_root]/src/algo/algo.h, execute the following command
[tugraph_root]/cpplint/cpplint.py src/algo/algo.cpp src/algo/algo.h
If cpplint.py reports some warnings, follow the prompts to modify until it is passed
You can also use the [tugraph_root]/cpplint/check_code_style.sh file, this script will check the source files involved in the latest git commit
If want to check all the cpp files in the src directory, use the following command
[tugraph_root]/cpplint/cpplint.py --recursive src
For more details, see cpplint or [tugraph_root]/cpplint/cpplint.py --help
You can use clang-format to format the code, the command is as follows:
clang-format -i src/algo/algo.cpp
clang-format tool needs to be installed on your own computer by yourself.
clang-format will look for the default configuration file .clang-format from the root path, which has been placed in the code repository and describes Google's cpp style.
For more Google's cpp style details, see English Version or 中文版
If you get errors that cpplint DO NOT recognize the Copyright, just take care of the BOM character with the next command(ueff).
find src test include toolkits plugins -name "*.cpp" -o -name "*.h" | grep -v "/lmdb/" | xargs sed -i '' '1s/^\xef\xbb\xbf//'In cpplint/cpplint.py:1850, the code are also modified to ignore BOM marker
if lines[lineix].replace('\ufeff', '').strip().startswith('/*'):