From 44e9391231acaa3f42e8ff3e0ec0d6e1a83c2e81 Mon Sep 17 00:00:00 2001 From: ryjiang Date: Mon, 25 Oct 2021 20:32:36 +0800 Subject: [PATCH] [skip ci]Format markdown doc for scripts_and_tools.md (#10598) Signed-off-by: ruiyi.jiang --- docs/design_docs/segcore/scripts_and_tools.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/design_docs/segcore/scripts_and_tools.md b/docs/design_docs/segcore/scripts_and_tools.md index 840755dcae..15ea51dc1d 100644 --- a/docs/design_docs/segcore/scripts_and_tools.md +++ b/docs/design_docs/segcore/scripts_and_tools.md @@ -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` \ No newline at end of file + - 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`