From 14df29be8c3fb31dce03fcd8bd9ad82df77ee0e7 Mon Sep 17 00:00:00 2001 From: zhangzegang Date: Fri, 1 Nov 2024 15:26:25 +0800 Subject: [PATCH] doc: add more anchors in npk related section Signed-off-by: zhangzegang --- source/ide/npk.rst | 22 +++++++++++++------ source/ide/npkmanage.rst | 46 ++++++++++++++++++++++++++++------------ 2 files changed, 47 insertions(+), 21 deletions(-) diff --git a/source/ide/npk.rst b/source/ide/npk.rst index b32c1ef..41a74af 100644 --- a/source/ide/npk.rst +++ b/source/ide/npk.rst @@ -1,4 +1,4 @@ -.. _npk: +.. _npk: Nuclei Studio NPK 应用 ======================= @@ -7,9 +7,13 @@ Nuclei Studio 中内建了对Nuclei Package（NPK）功能的完整支持，方 开发者要使用Nuclei Studio进行工程的创建，需先将对应的SDK NPK Zip包安装到IDE中，方可根据不同的开发板快速新建不同的模板工程，并根据不同的模板添加需要的SDK源码，根据选项生成不同的编译链接选项设置。 +.. _npk_package_management: + NPK软件包管理 ------------- +.. _npk_import_local_package: + 导入本地NPK软件包 ~~~~~~~~~~~~~~~~~ @@ -60,11 +64,12 @@ NPK软件包管理 |image28| +.. _npk_download_cloud_package: 下载云端NPK软件包 ~~~~~~~~~~~~~~~~~ -在Nuclei Studio中最大的更新，就是将npk云端化，用户直接在Nuclei Studio中就可以下查看到所有的npk并自行安装，在菜单栏选择 ``RV-Tools-->Nuclei Package Management`` 在弹出的Nuclei Package Management管理页进行npk管理。 +在Nuclei Studio中最大的更新，就是将npk云端化，用户直接在Nuclei Studio中就可以下查看到所有的npk并自行安装，在菜单栏选择 ``RV-Tools-->Nuclei Package Management`` 在弹出的**Nuclei Package Management**管理页进行npk管理。 |image1| @@ -97,7 +102,7 @@ NPK软件包管理 本章将在RVSTAR开发板上，以新建和修改GD32VF103的工程为例快速介绍Nuclei Studio功能，RVSTAR开发板开发需要使用nuclei_sdk的npk包，详细的流程请参考之后的章节。 -.. _ide_npk_package_management: +.. _npk_create_project: 创建NPK示例工程 ~~~~~~~~~~~~~~~ @@ -125,6 +130,8 @@ Nuclei Studio可以根据不同的工程模板添加不同的SDK源码，例如F Nuclei Studio可以根据新建工程时的选项自动设置工程的选项。这里选择使用浮点打印，所以 ``NEWLIB`` 选择 ``newlib nano with printf float`` 。之后一直选择 ``Next`` 直到 ``Finish`` 。 +.. _npk_sdk_config_tool: + SDK Configuration Tools更改工程配置 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -155,19 +162,20 @@ Tools将直接打开这个Nuclei Settings界面。 |image15| +.. _npk_import_tool_package: 通过NPK导入工具 --------------- NPK包除了可以导入SDK,还可以方便的导入各种工具包，来扩展Nuclei Studio的能力，2022.08版本的Nuclei Studio增加NPK Tools的支持，为增加组件包的可扩展性，以及在编译和调试上使用更便捷，增加类型为tool的npk组件包。tool组件包可包含gcc,qemu,cmlink-gdb等内容，以zip包的形式导入到IDE去使用。 -以tool-cmlink包为例，一个工具包中有该工具的执行文件及npk.yml，开发者在npk.yml文件中对该工具做了一些简单的描述，如工具包的开发者、版本、支持的操作系统、可执行文件的路径等，包结构和npk.yml内容如下示例。然后将工具包压缩成一个zip文件，可以参考4.1.章的内容，将npk tools导入到ide中，或共享到\ `www.rvmcu.com `__\ 网站上。 +以tool-cmlink包为例，一个工具包中有该工具的执行文件及npk.yml，开发者在npk.yml文件中对该工具做了一些简单的描述，如工具包的开发者、版本、支持的操作系统、可执行文件的路径等，包结构和npk.yml内容如下示例。然后将工具包压缩成一个zip文件，可以参考 :ref:`npk_import_local_package` 的内容，将npk tools导入到ide中，或共享到\ `www.rvmcu.com `__\ 网站上。 -- -bin +- ``bin`` -- -bin\\cmlink_gdbserver.exe +- ``bin\cmlink_gdbserver.exe`` -- -npk.yml +- ``npk.yml`` |image16| diff --git a/source/ide/npkmanage.rst b/source/ide/npkmanage.rst index 1fd83a6..7f1c11c 100644 --- a/source/ide/npkmanage.rst +++ b/source/ide/npkmanage.rst @@ -1,13 +1,17 @@ -.. _npkmanage: +.. _npkmanage: Nuclei Studio NPK 创建与共享 ============================ Nuclei Studio 2022.04版中，提供了一个非常重要的功能，该功能主要通过提供的各种初始模板，方便开发者去创建自己的NPK组件包，并可以通过平台将自己的NPK组件包贡献出来，供其他开发者使用。 -创建NPK组件包 +.. _npkmanage_develop_package: + +开发NPK组件包 --------------- +.. _npkmanage_auth_developer: + 认证开发者 ~~~~~~~~~~~ @@ -19,7 +23,7 @@ Nuclei Studio 2022.04版中，提供了一个非常重要的功能，该功能 .. |image1| image:: /asserts/nucleistudio/developer/authenticate.png - + 或者直接访问 `认证地址 `__ ，按提示分别填写相关信息，其中 **开发者** 对应的开发者空间地址的后辍将会是您的owner ID。 |image2| @@ -32,6 +36,7 @@ Nuclei Studio 2022.04版中，提供了一个非常重要的功能，该功能 .. |image3| image:: /asserts/nucleistudio/developer/authenticate3.png +.. _npkmanage_create_package: 创建NPK组件包 ~~~~~~~~~~~~~~ @@ -57,32 +62,32 @@ Nuclei Studio 2022.04版中，提供了一个非常重要的功能，该功能 .. |image6| image:: /asserts/nucleistudio/developer/image143.png -选择Type时，无对应模板时，会跳出对应提示，点击确定，进入Nuclei Package Management页面，根据需要下载Template Package的对应模板，或点击下图右下角Import自行导入。 +选择Type时，无对应模板时，会跳出对应提示，点击确定，进入Nuclei Package Management页面，根据需要下载Template Package的对应模板，或点击下图右下角Import自行导入。 下面以ssp类型模板为例,假设你的公司名称为GreenTech, 你的SoC名称为 gt25nv, 适配的开发板为gt25nv_devkit, 采用了我们的n307FD处理器(rv32imafdc)配置, 并且配置了dsp特性， 并且提供了ilm, flash,flashxip三种下载方式。 - -Type选择ssp： ``Soc Support Package`` - + +Type选择ssp: ``Soc Support Package`` + |image7| .. |image7| image:: /asserts/nucleistudio/developer/image147.png 其次进入缺少对应模板，进入Nuclei Package Management页面，选择 ``tpl-nsdk-soc-demosoc`` ，点击 ``Download`` 下载，下载完成后关闭该页面 - + |image8| .. |image8| image:: /asserts/nucleistudio/developer/image148.png 点击Next，在 ``Select a Template`` 中选择刚才下载的模板 ``tpl-nsdk-soc-demosoc`` ，左侧为模板描述和相关的文件预览，右侧为模板中部分可自定义的内容。 - + |image9| .. |image9| image:: /asserts/nucleistudio/developer/image145.png - -我们这里举例，公司名称为 ``GreenTech`` ，SoC名称为 ``gt25nv`` ，适配的开发板为 ``gt25nv_devkit`` ，采用了我们的n307FD处理器( ``rv32imafdc`` )配置，并且配置了dsp特性，并且提供了ilm，flash，flashxip三种下载方式。然后Nuclei RISC-V Core选择为 ``NX600`` ，经过修改后如图。 - + +我们这里举例，公司名称为 ``GreenTech`` ，SoC名称为 ``gt25nv`` ，适配的开发板为 ``gt25nv_devkit`` ，采用了我们的n307FD处理器( ``rv32imafdc`` )配置，并且配置了dsp特性，并且提供了ilm，flash，flashxip三种下载方式。然后Nuclei RISC-V Core选择为 ``NX600`` ，经过修改后如图。 + |image10| .. |image10| image:: /asserts/nucleistudio/developer/image149.png @@ -101,7 +106,7 @@ Type选择ssp： ``Soc Support Package`` .. |image12| image:: /asserts/nucleistudio/developer/image151.png - + |image13| .. |image13| image:: /asserts/nucleistudio/developer/image150.png @@ -112,9 +117,13 @@ Type选择ssp： ``Soc Support Package`` .. |image14| image:: /asserts/nucleistudio/developer/image152.png +.. _npkmanage_test_package: + 测试NPK组件包 -------------- +.. _npkmanage_create_test_project: + 创建测试项目 ~~~~~~~~~~~~~~ @@ -136,6 +145,7 @@ Type选择ssp： ``Soc Support Package`` .. |image17| image:: /asserts/nucleistudio/developer/image155.png +.. _npkmanage_workwith_test_project: 编译调试测试工程 ~~~~~~~~~~~~~~~~~~ @@ -149,9 +159,13 @@ Type选择ssp： ``Soc Support Package`` .. |image18| image:: /asserts/nucleistudio/developer/image156.png +.. _npkmanage_share_package: + 共享NPK组件包 --------------- +.. _npkmanage_share_npk: + NPK组件包共享 ~~~~~~~~~~~~~~ @@ -194,6 +208,8 @@ NPK组件包共享 .. |image24| image:: /asserts/nucleistudio/developer/image164.png +.. _npkmanage_update_npk: + NPK组件包升级 ~~~~~~~~~~~~~~ @@ -207,12 +223,14 @@ NPK组件包升级 .. |image26| image:: /asserts/nucleistudio/developer/image166.png - + |image27| .. |image27| image:: /asserts/nucleistudio/developer/image167.png +.. _npkmanage_using_npk_in_ide: + NPK组件包在Nuclei Studio中的使用 ---------------------------------