From 21dc7cdb6436c0eb8e9a97607639cc763a1977f3 Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:21:25 +0800 Subject: [PATCH 1/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=A6=82=E4=BD=95?= =?UTF-8?q?=E6=A3=80=E7=B4=A2=E5=92=8C=E5=AE=89=E8=A3=85=E6=8F=92=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/如何检索和安装插件.md | 37 +++++++++++++++++--------- 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/user-guide/files/如何检索和安装插件.md b/user-guide/files/如何检索和安装插件.md index 3cdd4d7..86b1c5f 100644 --- a/user-guide/files/如何检索和安装插件.md +++ b/user-guide/files/如何检索和安装插件.md @@ -2,35 +2,48 @@ - [检索插件](#检索插件) - [安装插件](#安装插件) - - [通过插件商店安装](#通过插件商店安装) - - [安装插件打包文件vsix](#安装插件打包文件vsix) - - [通过名利命令行安装](#通过名利命令行安装) + - [通过插件市场在线安装](#通过插件市场在线安装) + - [本地离线安装](#本地离线安装) + - [从VSIX安装插件文件](#从VSIX安装插件文件) + - [通过离线插件管理器安装](#通过离线插件管理器安装) + - [通过终端命令行安装](#通过终端命令行安装) + - [不要忘记安装插件依赖](#不要忘记安装插件依赖) ## 检索插件 -IDE软件定义了通过IDE基础平台定制的插件分类搜索菜单检索到我们的插件，通过这些分类可以检索插件商店的插件。在插件页面中，点击侧边栏顶部“筛选”按钮，选择Kylin-IDE（KylinCode）插件分类，会按照分类搜索插件市场中KylinIDETeam发布的插件。 - -![检索插件](./resources/useExtensions/extension-classification.png) +- 可以通过IDE基础平台定制的插件分类检索菜单检索到KylinIdeTeam开发适配的插件 + * 在插件页面中，点击侧边栏顶部“筛选”按钮，选择Kylin-IDE（KylinCode）插件分类，可以按照分类检索插件市场中KylinIDETeam开发适配的插件。 + * ![检索插件](./resources/useExtensions/find-our-ext.jpg) +- KylinIdeTeam开发适配的插件还汇总在openKylin [extensions-repo仓库](https://gitee.com/openkylin/extensions-repo/tree/master/KylinIDETeam)中，可以在此仓库中手动检索、下载插件 ## 安装插件 -### 通过插件商店安装 +### 通过插件市场在线安装 当搜索到要安装的插件，点击搜索列表和插件详情页面的“安装”按钮，就会安装该插件。 ![通过插件商店安装](./resources/useExtensions/extensionInstall.PNG) -### 安装插件打包文件vsix +### 本地离线安装 +插件通常被打包为以.vsix为后缀的文件 + +#### 从VSIX安装插件文件 用户可以通过使用“扩展视图”更多菜单中下拉列表中的"从 VSIX 安装"命令，弹出的文件选择器窗口中指向“.vsix”文件，来安装插件。 -![安装插件打包文件](./resources/useExtensions/installVisx.gif) +![从VSIX安装插件文件](./resources/useExtensions/installVisx.gif) -### 通过终端命令行安装 +#### 通过离线插件管理器安装 +见[离线插件管理章节](./离线插件管理.md) + +#### 通过终端命令行安装 用户打开系统终端或者IDE基础平台终端，输入命令来安装vsix文件。例如myextension.vsix这个插件在当前目录下，可以使用如下命令进行安装。 -如果是kylin-ide，命令如下： +kylin-ide IDE基础平台，命令如下： ``` kylin-ide --install-extension myextension.vsix ``` -如果是kylin-code，命令如下： +kylin-code IDE基础平台，命令如下： ``` kylin-code --install-extension myextension.vsix ``` + +## 不要忘记安装插件依赖 +有些插件需要调用系统软件完成功能，这些系统软件称之为插件依赖。**安装插件后，不要忘记处理这些插件依赖**。插件通常会有提示来引导用户安装依赖软件。而对于KylinIdeTeam开发适配的插件（配置了depends.json文件），可以使用插件依赖管理器较便捷地处理插件依赖，详细见[插件依赖管理章节](./插件依赖管理.md) \ No newline at end of file From f5cef5cfbe28d6b8a31641546370c705441da352 Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:32:23 +0800 Subject: [PATCH 2/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=A6=BB=E7=BA=BF?= =?UTF-8?q?=E6=8F=92=E4=BB=B6=E7=AE=A1=E7=90=86=E6=8F=92=E4=BB=B6=E5=AE=89?= =?UTF-8?q?=E8=A3=85=E4=BD=BF=E7=94=A8=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/离线插件管理.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/user-guide/files/离线插件管理.md b/user-guide/files/离线插件管理.md index 49b185d..7995d4d 100644 --- a/user-guide/files/离线插件管理.md +++ b/user-guide/files/离线插件管理.md @@ -1,7 +1,7 @@ - # 离线插件管理插件安装使用说明 +在[如何检索和安装插件章节](./如何检索和安装插件.md)中，介绍了“从VSIX安装插件”的方法。设想这样一种场景，很多插件放在一个文件夹中，如何在安装前预览插件功能，如何仅安装C开发插件而不安装所有插件？此时，“从VSIX安装插件”不能满足需求，可以使用本章节描述的离线插件管理器 -## 1、插件安装 +## 1、离线插件管理器安装 - 通过插件筛选器，找到 offline-extensions-manager 插件 @@ -11,7 +11,7 @@ ![图1-2](resources/offline-extensions-manager/om-install.png "离线插件管理安装") -- 完成安装，请重新加载主程序插件。 +- 完成安装，请重新加载。 ## 2、离线插件管理插件操作区 @@ -32,7 +32,7 @@ ## 4、离线插件的分类检索 ### 4.1、预定义关键字检索插件 -Select菜单中关键字和Kylin-Code插件分类关键字大致一致，包括：所有、KylinIDE、C语言支持、C++语言支持、Java语言支持、Go语言支持、Python语言支持、Javascript语言支持、Rust语言支持、C#语言支持、其他编程语言支持、项目创建、编辑、编译、调试、打包、远程开发、性能分析、插件管理器、其他、合作者。其中三个(Rust语言支持、C#语言支持、其他)关键字为离线插件管理器自定义添加。 +Select菜单中关键字和Kylin-IDE(KylinCode)插件分类关键字大致一致，包括：所有、KylinIDE、C语言支持、C++语言支持、Java语言支持、Go语言支持、Python语言支持、Javascript语言支持、Rust语言支持、C#语言支持、其他编程语言支持、项目创建、编辑、编译、调试、打包、远程开发、性能分析、插件管理器、其他、合作者。其中三个(Rust语言支持、C#语言支持、其他)关键字为离线插件管理器自定义添加。 - 点击Select的“所有”菜单,则显示导入所有插件 - 点击Select的“其他”菜单,则显示导入第三方插件 From d13003b0d2ce3e8b6690d43c58ac1193a634fc5e Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:48:00 +0800 Subject: [PATCH 3/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E8=BF=9C=E7=A8=8B?= =?UTF-8?q?=E5=BC=80=E5=8F=91=EF=BC=8C=E4=BF=AE=E6=94=B9=E5=B0=91=E9=87=8F?= =?UTF-8?q?=E6=8F=8F=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/远程开发.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/user-guide/files/远程开发.md b/user-guide/files/远程开发.md index 9c642db..96b0212 100644 --- a/user-guide/files/远程开发.md +++ b/user-guide/files/远程开发.md @@ -1,6 +1,6 @@ # 远程开发功能使用说明 ## 功能概述 -远程开发功能支持通过linux或windows客户端连接到远程机上进行代码开发功能，目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能，linux和windows客户端上使用方法有所不同，具体使用方法如下： +远程开发功能支持通过Linux或Windows操作系统客户端连接到远程机上进行代码开发功能，目前支持x86_64、loongarch64、aarch64三种架构。为用户提供远程编辑、远程编译、远程运行、远程调试等功能，Linux和Windows客户端上使用方法有所不同，具体使用方法如下： - [Linux远程开发插件安装使用说明](#linux远程开发插件安装使用说明) - [准备工作](#1准备工作) - [插件安装](#2插件安装) @@ -19,7 +19,8 @@ - 检查“远程机”的sshd服务是否正常，“/etc/ssh/sshd_config”中 “AllowTcpForwarding”和“PermitTunnel”为yes，如果“AllowTcpForwarding”和“PermitTunnel”为no，请修改配置，并重启sshd服务 - 检查在客户机是否能够通过ssh连接到远程机 ### 2、插件安装 -- 从插件商店搜索`Kylin remote development`远程开发插件并安装 +- 本地客户端机器需要先安装IDE基础平台，见[简介章节](./简介.md) +- 从插件市场中搜索`Kylin remote development`远程开发插件并安装 ![图2-1](resources/kylin-remote-dev/remote-dev-install-from-open.png "通过插件商店安装插件") @@ -63,8 +64,8 @@ ### 5、项目管理、多语言开发、调试功能使用 - 通过远程开发插件打开远程开发环境后，其使用方法和Kylin-IDE(KylinCode)编辑器类似。 - - 远程插件商店设置 - - 默认使用“https://open-vsx.org”商店，如果更改插件商店，请在设置中进行修改：点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。 + - 远程插件市场设置 + - 默认使用OpenVSX插件市场，如果更改插件市场，请在设置中进行修改：点击左下角的设置->在弹出的页面中搜索gallery关键字->在输入框中输入serviceUrl和itemUrl。 ![图5-1](resources/kylin-remote-dev/remote-extension.png "插件商店设置") - 插件安装 From 7bd068df4c18bbb82046c6e70382beb6bea8e863 Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:52:05 +0800 Subject: [PATCH 4/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=89=88=E6=9C=AC?= =?UTF-8?q?=E7=AE=A1=E7=90=86=E5=B7=A5=E5=85=B7=20=E6=8F=92=E4=BB=B6?= =?UTF-8?q?=E5=AE=89=E8=A3=85=E6=8F=8F=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/版本管理工具.md | 1 + 1 file changed, 1 insertion(+) diff --git a/user-guide/files/版本管理工具.md b/user-guide/files/版本管理工具.md index 9488c75..6175a5b 100644 --- a/user-guide/files/版本管理工具.md +++ b/user-guide/files/版本管理工具.md @@ -1,6 +1,7 @@ # 1、 版本管理工具安装使用说明 ## 1.1、 插件安装 +IDE基础平台已经集成了基本的git功能，git增强功能，例如代码文件内显示git操作历史，需要安装如下步骤安装插件： 1. 通过插件筛选器，点击源代码管理，找到 Gitlens lower version for friendly licence 插件; From 8a6c2ae03e3dbca43ad874e35ed7dda92d345586 Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:53:22 +0800 Subject: [PATCH 5/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=8F=92=E4=BB=B6?= =?UTF-8?q?=E5=AE=89=E8=A3=85=E6=8F=8F=E8=BF=B0=EF=BC=8C=E9=81=BF=E5=85=8D?= =?UTF-8?q?=E6=AD=A7=E4=B9=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/版本管理工具.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user-guide/files/版本管理工具.md b/user-guide/files/版本管理工具.md index 6175a5b..dff1ee2 100644 --- a/user-guide/files/版本管理工具.md +++ b/user-guide/files/版本管理工具.md @@ -1,7 +1,7 @@ # 1、 版本管理工具安装使用说明 ## 1.1、 插件安装 -IDE基础平台已经集成了基本的git功能，git增强功能，例如代码文件内显示git操作历史，需要安装如下步骤安装插件： +IDE基础平台已经集成了基本的git功能。使用git增强功能，例如代码文件内显示git操作历史，需要安装如下步骤安装插件： 1. 通过插件筛选器，点击源代码管理，找到 Gitlens lower version for friendly licence 插件; From 2741347007af2d3b9ef4bbe5a1333037a6078b24 Mon Sep 17 00:00:00 2001 From: muruichao Date: Thu, 3 Aug 2023 09:59:53 +0800 Subject: [PATCH 6/6] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=8E=86=E5=8F=B2?= =?UTF-8?q?=E8=B0=83=E8=AF=95=EF=BC=8C=E5=B0=91=E9=87=8F=E6=8F=8F=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- user-guide/files/历史调试.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/user-guide/files/历史调试.md b/user-guide/files/历史调试.md index 2997027..5ab6564 100644 --- a/user-guide/files/历史调试.md +++ b/user-guide/files/历史调试.md @@ -1,8 +1,7 @@ # 历史调试插件安装使用说明 -历史调试功能正在开发完善中，目前的版本为尝鲜版 ## 1、插件说明 -历史调试插件可在调试过程中记录中断时的堆栈信息，并可在调试过程中或结束后查看调试时的堆栈信息，用户可在调试过程中记录关心的调试信息以便在需要的时候复现调试信息。 +历史调试插件可在调试过程中记录中断时的堆栈信息，并可在调试过程中或结束后查看调试时的堆栈信息，用户可在调试过程中记录关心的调试信息以便在需要的时候回放调试信息。 --- ### 特点 @@ -31,7 +30,7 @@ ## 3、历史调试 ### 3.1 准备工作 - * 历史调试可对多种语言进行调试，以C++为例，确认 KylinIde(KylinCode) 上安装了 Kylin Native Debug 和 historyDebug 插件，gdb 已安装 + * 历史调试可对多种语言进行调试，以C++为例，确认 Kylin-IDE(KylinCode) 上安装了 Kylin Native Debug 和 historyDebug 插件，调试器gdb已安装 ![图3-1](./resources/historyDebug/hd-c-ext.png "调试插件已安装") ![图3-2](./resources/historyDebug/hd-gdb.png "gdb已安装") @@ -66,7 +65,7 @@ * 红色-该中断处调试信息未记录完成 其中状态为红色时可继续点击继续按钮，不影响后续中断处调试信息记录，但该处调试信息未完成记录，进行历史调试时可能会有堆栈或变量信息不能正常显示。 -3. 反向调试 +3. 调试回放 点击活动栏“历史调试”按钮，点击侧边栏上方“最后一条”按钮，可以看到历史调试插件已记录了最新的调试信息，此时可以根据需要对之前的记录进行查看，相应操作为“第一条”、“上一条”、“下一条”，“最后一条”，查看操作不会中断调试过程。 4. 历史调试查找