adonis0147 commented on a change in pull request #8642:
URL: https://github.com/apache/incubator-doris/pull/8642#discussion_r834903719
##########
File path: docs/en/developer-guide/cpp-diagnostic-code.md
##########
@@ -0,0 +1,53 @@
+---
+{
+ "title": "C++ Code Diagnostic",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# C++ Code Diagnostic
+
+Doris support to use [Clangd](https://clangd.llvm.org/) and
[Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) to diagnostic code.
Clangd and Clang-Tidy already has in
[LDB-toolchain](https://doris.apache.org/zh-CN/installing/compilation-with-ldb-toolchain)，also
can install by self.
+
+### Clang-Tidy
+Clang-Tidy can do some diagnostic cofig, config file `.clang-tidy` is in Doris
root path.
+
+### Enable clangd on VSCODE
+
+First we should install clangd plugin, then edit `settings.json` or just
change config on gui.
+
+```json
+ "clangd.path": "ldb_toolchain/bin/clangd", //clangd path
+ "clangd.arguments": [
+ "--background-index",
+ "--clang-tidy", //enable clang-tidy
+ "--compile-commands-dir=doris/be/build_RELEASE/", //clangd should read
compile_commands.json create by cmake, so you should compile once
+ "--completion-style=detailed",
+ "-j=5", //clangd diagnostic parallelism
+ "--all-scopes-completion",
+ "--pch-storage=memory",
+ "--pretty",
+ "-log=verbose",
+ "--query-driver=ldb_toolchain/bin/g++" //path of g++ or clang++
Review comment:
```suggestion
"--query-driver=ldb_toolchain/bin/*" // path of compiler
```
Using wildcard to match is better.
--
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: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
