You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by mo...@apache.org on 2022/05/27 13:58:54 UTC
[incubator-doris] branch master updated: [doc] Add a note about the version of checkstyle (#9785)
This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new cfe640c37b [doc] Add a note about the version of checkstyle (#9785)
cfe640c37b is described below
commit cfe640c37bf905c7adbd03cd2cc6a64e50125fe2
Author: Adonis Ling <ad...@gmail.com>
AuthorDate: Fri May 27 21:58:49 2022 +0800
[doc] Add a note about the version of checkstyle (#9785)
---
.../.vuepress/public/images/idea-checkstyle-version.png | Bin 0 -> 48448 bytes
docs/en/developer-guide/java-format-code.md | 4 ++++
docs/zh-CN/developer-guide/java-format-code.md | 4 ++++
3 files changed, 8 insertions(+)
diff --git a/docs/.vuepress/public/images/idea-checkstyle-version.png b/docs/.vuepress/public/images/idea-checkstyle-version.png
new file mode 100644
index 0000000000..a512e98fe2
Binary files /dev/null and b/docs/.vuepress/public/images/idea-checkstyle-version.png differ
diff --git a/docs/en/developer-guide/java-format-code.md b/docs/en/developer-guide/java-format-code.md
index ef7b4e1fe9..ab80066ba1 100644
--- a/docs/en/developer-guide/java-format-code.md
+++ b/docs/en/developer-guide/java-format-code.md
@@ -54,6 +54,10 @@ Setting the `checkstyle.xml` file in `Tools->Checkstyle`.
Click the plus sign under Configuration File, select `Use a local Checkstyle file`, and select the `fe/check/checkstyle/checkstyle.xml` file.
+**NOTE:** Make sure that the version of `Checkstyle` is 9.3 or newer (the latest version is recommended).
+
+
+
### VS Code
If you use VS Code to develop Java code, please install `Checkstyle for Java` plugin, and config according to the [document](https://code.visualstudio.com/docs/java/java-linting) and the picture
diff --git a/docs/zh-CN/developer-guide/java-format-code.md b/docs/zh-CN/developer-guide/java-format-code.md
index 125e80ac72..09f05a2f05 100644
--- a/docs/zh-CN/developer-guide/java-format-code.md
+++ b/docs/zh-CN/developer-guide/java-format-code.md
@@ -52,6 +52,10 @@ standard java package
在 `Tools->Checkstyle` 的 `Configuration File` 里点击 `Use a local Checkstyle file`，选择项目的 `fe/check/checkstyle/checkstyle.xml` 文件。
+**注意：** 保证`Checkstyle`的版本在9.3及以上（推荐使用最新版本）。
+
+
+
### VS Code
如果使用 VS Code 进行 Java 开发，请安装 `Checkstyle for Java` 插件，按照[文档](https://code.visualstudio.com/docs/java/java-linting)里的说明和动图进行配置。
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org