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 69ab1f8681 [doc] add doc of fe dev in vscode (#8875)
69ab1f8681 is described below
commit 69ab1f868191dd88aeb27c50c553200196b0953e
Author: jakevin <[email protected]>
AuthorDate: Fri Apr 8 09:12:43 2022 +0800
[doc] add doc of fe dev in vscode (#8875)
---
docs/.vuepress/sidebar/en.js | 41 +++++------
docs/.vuepress/sidebar/zh-CN.js | 41 +++++------
docs/en/developer-guide/fe-vscode-dev.md | 80 ++++++++++++++++++++++
...How-to-Share-blogs.md => how-to-share-blogs.md} | 8 +--
docs/zh-CN/developer-guide/fe-vscode-dev.md | 80 ++++++++++++++++++++++
...How-to-Share-blogs.md => how-to-share-blogs.md} | 9 ++-
6 files changed, 210 insertions(+), 49 deletions(-)
diff --git a/docs/.vuepress/sidebar/en.js b/docs/.vuepress/sidebar/en.js
index 070ce723cb..c4b80e6d00 100644
--- a/docs/.vuepress/sidebar/en.js
+++ b/docs/.vuepress/sidebar/en.js
@@ -764,11 +764,12 @@ module.exports = [
"benchmark-tool",
"fe-eclipse-dev",
"fe-idea-dev",
+ "fe-vscode-dev",
"be-vscode-dev",
"java-format-code",
"cpp-format-code",
"cpp-diagnostic-code",
- "How-to-Share-blogs",
+ "how-to-share-blogs",
"minidump",
"bitmap-hll-file-format",
],
@@ -792,27 +793,27 @@ module.exports = [
"subscribe-mail-list",
"feedback",
{
- title: "How to Contribute",
- directoryPath: "how-to-contribute/",
- initialOpenGroupIndex: -1,
- children: [
- "how-to-contribute",
- "committer-guide",
- "commit-format-specification",
- "pull-request",
- ],
+ title: "How to Contribute",
+ directoryPath: "how-to-contribute/",
+ initialOpenGroupIndex: -1,
+ children: [
+ "how-to-contribute",
+ "committer-guide",
+ "commit-format-specification",
+ "pull-request",
+ ],
},
{
- title: "Release Process & Verification",
- directoryPath: "release-and-verify/",
- initialOpenGroupIndex: -1,
- children: [
- "release-prepare",
- "release-doris-core",
- "release-doris-connectors",
- "release-complete",
- "release-verify",
- ],
+ title: "Release Process & Verification",
+ directoryPath: "release-and-verify/",
+ initialOpenGroupIndex: -1,
+ children: [
+ "release-prepare",
+ "release-doris-core",
+ "release-doris-connectors",
+ "release-complete",
+ "release-verify",
+ ],
},
"security",
],
diff --git a/docs/.vuepress/sidebar/zh-CN.js b/docs/.vuepress/sidebar/zh-CN.js
index f97101333b..bfbb31f865 100644
--- a/docs/.vuepress/sidebar/zh-CN.js
+++ b/docs/.vuepress/sidebar/zh-CN.js
@@ -778,11 +778,12 @@ module.exports = [
"docker-dev",
"fe-eclipse-dev",
"fe-idea-dev",
+ "fe-vscode-dev",
"be-vscode-dev",
"java-format-code",
"cpp-format-code",
"cpp-diagnostic-code",
- "How-to-Share-blogs",
+ "how-to-share-blogs",
"minidump",
"bitmap-hll-file-format",
"regression-testing",
@@ -807,27 +808,27 @@ module.exports = [
"subscribe-mail-list",
"feedback",
{
- title: "贡献指南",
- directoryPath: "how-to-contribute/",
- initialOpenGroupIndex: -1,
- children: [
- "how-to-contribute",
- "committer-guide",
- "commit-format-specification",
- "pull-request",
- ],
+ title: "贡献指南",
+ directoryPath: "how-to-contribute/",
+ initialOpenGroupIndex: -1,
+ children: [
+ "how-to-contribute",
+ "committer-guide",
+ "commit-format-specification",
+ "pull-request",
+ ],
},
{
- title: "版本发布与校验",
- directoryPath: "release-and-verify/",
- initialOpenGroupIndex: -1,
- children: [
- "release-prepare",
- "release-doris-core",
- "release-doris-connectors",
- "release-complete",
- "release-verify",
- ],
+ title: "版本发布与校验",
+ directoryPath: "release-and-verify/",
+ initialOpenGroupIndex: -1,
+ children: [
+ "release-prepare",
+ "release-doris-core",
+ "release-doris-connectors",
+ "release-complete",
+ "release-verify",
+ ],
},
"security",
],
diff --git a/docs/en/developer-guide/fe-vscode-dev.md
b/docs/en/developer-guide/fe-vscode-dev.md
new file mode 100644
index 0000000000..e90fc05269
--- /dev/null
+++ b/docs/en/developer-guide/fe-vscode-dev.md
@@ -0,0 +1,80 @@
+---
+{
+ "title": "FE development and debugging environment - Visual Studio Code
(VSCode)",
+ "language": "zh-CN"
+}
+---
+
+<!--
+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.
+-->
+
+# Apache Doris Be development and debugging in VS Code
+
+Some developers are building FE development environment on a development
machine/WSL/docker, but this kind of development environment is not supported
for local development, some developers are used to use VSCode to configure
remote develop and debug.
+
+## Preparation
+
+* JDK11+ (Java Extension Pack need JDK11+) (author is creating a `lib`
directory under `home`, and install
[JDK11](https://github.com/adoptium/temurin11-binaries/releases/) and JDK8 in
it, and use them for `Extensions` and `Compilation`)
+* VSCode
+ + Extension Pack for Java
+ + Remote Extensions
+
+## Download code for compilation
+
+1. https://github.com/apache/incubator-doris.git Download the doris source code
+
+2. use VSCode to open the code `/fe` directory
+
+## Setting for VSCode
+
+Create `settings.json` in `.vscode/` , and set settings:
+
+* `"java.configuration.runtimes"`
+* `"java.jdt.ls.java.home"` -- must set it to the directory of JDK11+, used
for vscode-java plugin
+* `"maven.executable.path"` -- maven path，for maven-language-server plugin
+
+example:
+
+```json
+{
+ "java.configuration.runtimes": [
+ {
+ "name": "JavaSE-1.8",
+ "path": "/!!!path!!!/jdk-1.8.0_191"
+ },
+ {
+ "name": "JavaSE-11",
+ "path": "/!!!path!!!/jdk-11.0.14.1+1",
+ "default": true
+ },
+ ],
+ "java.jdt.ls.java.home": "/!!!path!!!/jdk-11.0.14.1+1",
+ "maven.executable.path": "/!!!path!!!/maven/bin/mvn"
+}
+```
+
+## Build
+
+Other articles have already explained:
+* [Build with LDB toolchain
](https://doris.apache.org/zh-CN/installing/compilation-with-ldb-toolchain.html)
+* ......
+
+In order to debug, you need to add debugging parameters when fe starts, such
as `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005` .
+
+In `incubator-doris/output/fe/bin/start_fe.sh` , after `$JAVA $final_java_opt`
add this param.
diff --git a/docs/en/developer-guide/How-to-Share-blogs.md
b/docs/en/developer-guide/how-to-share-blogs.md
similarity index 89%
rename from docs/en/developer-guide/How-to-Share-blogs.md
rename to docs/en/developer-guide/how-to-share-blogs.md
index 68979f1b1e..15bf740a0c 100644
--- a/docs/en/developer-guide/How-to-Share-blogs.md
+++ b/docs/en/developer-guide/how-to-share-blogs.md
@@ -1,7 +1,7 @@
---
{
- "title": "How to Share blogs",
- "language": "zh-CN"
+ "title": "How to share blogs",
+ "language": "zh-CN"
}
---
@@ -16,7 +16,7 @@ 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,
+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
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# How to share a Blog
+# How to share a blog
The Doris community welcomes the sharing of Doris-related articles. Once
merged, these articles will appear on the official Doris website.
diff --git a/docs/zh-CN/developer-guide/fe-vscode-dev.md
b/docs/zh-CN/developer-guide/fe-vscode-dev.md
new file mode 100644
index 0000000000..b30d4c9152
--- /dev/null
+++ b/docs/zh-CN/developer-guide/fe-vscode-dev.md
@@ -0,0 +1,80 @@
+---
+{
+ "title": "FE 开发环境搭建 - Visual Studio Code (VSCode)",
+ "language": "zh-CN"
+}
+---
+
+<!--
+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.
+-->
+
+# 使用 VSCode 搭建 FE 开发环境
+
+有些开发者是在 开发机/WSL/docker 上搭建 FE 开发环境，但是这样的开发环境不能支持本地开发，有些习惯于使用 VSCode
的开发者可以配置远程开发调试
+
+## 环境准备
+
+* JDK11+ (Java 插件需要 JDK11+) (笔者是在 `home` 目录下建立了一个 lib 目录，分别安装了
[JDK11](https://github.com/adoptium/temurin11-binaries/releases/) 和 JDK8
，分别用于插件和编译)
+* VSCode
+ + Extension Pack for Java 插件
+ + Remote 插件
+
+## 下载代码编译
+
+1. 从 https://github.com/apache/incubator-doris.git 下载源码到本地
+
+2. 使用 VSCode 打开代码 `/fe` 目录
+
+## 配置 VSCode
+
+在 `.vscode` 目录下创建 `settings.json` 文件, 分别配置
+
+* `"java.configuration.runtimes"`
+* `"java.jdt.ls.java.home"` -- 必须另外配置，指向 JDK11+ 的目录，用于配置 vscode-java 插件
+* `"maven.executable.path"` -- 指向 maven 的目录，用于配置 maven-language-server 插件
+
+example:
+
+```json
+{
+ "java.configuration.runtimes": [
+ {
+ "name": "JavaSE-1.8",
+ "path": "/!!!path!!!/jdk-1.8.0_191"
+ },
+ {
+ "name": "JavaSE-11",
+ "path": "/!!!path!!!/jdk-11.0.14.1+1",
+ "default": true
+ },
+ ],
+ "java.jdt.ls.java.home": "/!!!path!!!/jdk-11.0.14.1+1",
+ "maven.executable.path": "/!!!path!!!/maven/bin/mvn"
+}
+```
+
+## 编译
+
+其他文章已经介绍的比较清楚了：
+* [使用 LDB toolchain
编译](https://doris.apache.org/zh-CN/installing/compilation-with-ldb-toolchain.html)
+* ......
+
+为了进行调试，需要在 fe 启动时，加上调试的参数，比如
`-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005` 。
+
+具体是在 `incubator-doris/output/fe/bin/start_fe.sh` 里 `$JAVA $final_java_opt`
后面加上上面的参数。
diff --git a/docs/zh-CN/developer-guide/How-to-Share-blogs.md
b/docs/zh-CN/developer-guide/how-to-share-blogs.md
similarity index 89%
rename from docs/zh-CN/developer-guide/How-to-Share-blogs.md
rename to docs/zh-CN/developer-guide/how-to-share-blogs.md
index 0f0a5e95fd..0b453928d5 100644
--- a/docs/zh-CN/developer-guide/How-to-Share-blogs.md
+++ b/docs/zh-CN/developer-guide/how-to-share-blogs.md
@@ -1,7 +1,7 @@
---
{
- "title": "如何分享Blog",
- "language": "zh-CN"
+ "title": "如何分享Blog",
+ "language": "zh-CN"
}
---
@@ -16,7 +16,7 @@ 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,
+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
@@ -24,7 +24,7 @@ specific language governing permissions and limitations
under the License.
-->
-# 如何分享Blog
+# 如何分享 Blog
Doris 社区欢迎大家分享 Doris 相关的文章。这些文章一经合入，将会出现在 Doris 官网网站上。
@@ -37,4 +37,3 @@ Doris 社区欢迎大家分享 Doris 相关的文章。这些文章一经合入
* Doris 业务场景实践
具体说明，请前往：https://github.com/apache/incubator-doris-website 参阅
[README](https://github.com/apache/incubator-doris-website)
-
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
