admin/milvus
1
0
Fork 0
mirror of https://gitee.com/milvus-io/milvus.git synced 2026-01-07 19:31:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci]Format markdown doc for scripts_and_tools.md (#10598)

Browse Source 
Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com>
This commit is contained in:
ryjiang 2021-10-25 20:32:36 +08:00 committed by GitHub
parent 5f5949cf2f
commit 44e9391231
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/design_docs/segcore/scripts_and_tools.md
View File

@ -1,14 +1,16 @@
# Scripts and Tools
The following scripts and commands may be used during segcore development
## code format
## code format
- under milvus/internal/core directory
- run `./run_clang_format .` to format cpp code
- to call clang-format-10, need to install `apt install clang-format-10` in advance
- call `build-support/add_${lang}_license.sh` to add license info for cmake and cpp file
- run `./run_clang_format .` to format cpp code
- to call clang-format-10, need to install `apt install clang-format-10` in advance
- call `build-support/add_${lang}_license.sh` to add license info for cmake and cpp file
- under milvus/ directory
- use `make cppcheck` to check format, including
- if clang-format is executed
- if license info is added
- if `cpplint.py` standard meets , might need to be fixed by hand
- `make verifier` also include functions in `make cppcheck`
- use `make cppcheck` to check format, including
- if clang-format is executed
- if license info is added
- if `cpplint.py` standard meets , might need to be fixed by hand
- `make verifier` also include functions in `make cppcheck`