Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update document for nuclei studio 2024.12 #16

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

laomaolaile
Copy link
Contributor

新增了Nuclei Studio 2024.12版相关文档

  • 新增2024.12版更新说明
  • 新增Flash Programming功能相关文档
  • 新增了Nuclei NICE Wizard相关文档
  • 新增Nuclei Model功能的使用相关文档
  • 优化Nuclei Near Cycle Model相关文档
  • 新增Live Watch功能相关文档

更新部分图片

Copy link
Member

@fanghuaqi fanghuaqi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

请按照上面的要求修改。同步也把其他的文件里面可以内部引用链接的地方清理下,包括qemu/gcc/model/openocd里面


创建完成的软件包,在导入之前,可以先使用检查工具检测npk组件包的合法性,避免导入失败。其核心功能聚焦于代码风格、变量命名、函数结构以及依赖关系的合规性检查,确保代码质量。

关于该工具的内容请参见: `软件包检查工具 <https://gito.corp.nucleisys.com/software/ide/npk-checker>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个工具你怎么给的是内网的repo,要外网的 https://github.com/Nuclei-Software/npk-checker

其他的如果有类似内网的链接也请检查梳理 @laomaolaile

.. |image30| image:: /asserts/nucleistudio/developer/image169.png


2、当日志中出现类似There are file parsing exceptions提示时,可以去对应的`用户目录\nuclei-pack-npk-v2\CFGs\logs\sys\`路径下看当天的日志文件,进一步了解相关npk文件的问题点,以便进行相应的修正。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

用户目录\nuclei-pack-npk-v2\CFGs\logs\sys\ -> 用户目录\nuclei-pack-npk-v2\CFGs\logs\sys\

RST里面引用是 ``


.. |image4| image:: /asserts/nucleistudio/projectbuild/image5.png
Load的文件,默认的elf格试的文件,也可以支持 ``*.bin、*.hex、*.s19、*.srec、*.symbolsrec`` 等各种格式
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symbolsrec 这个是啥格式?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

这个选项编出来的文件就是*.symbolsrec的


.. |image7| image:: /asserts/nucleistudio/projectbuild/image8.png
Reset and Run:选中时,Download命令会带上 ``rest`` 参数,这条指令在执行完load后可能强制系统复位(SRST),并让目标设备运行。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rest 是笔误?


新增指令
~~~~~~~~
点击 ``Add...`` ,根据需要修改指令内容后,点击右上角 ``save`` 即可。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

加一个空行

| ``--logdir=<str>`` | the directory to save trace and gprof files |
+--------------------+-------------------------------------------------------------------------------------------------+

在演示示例的Config options中配置了 ``--trace=1 --gprof=1 --logdir=Debug --cpu=n300fd`` , ``--trace=1`` 表示开启rvtrace, ``--gprof=1`` 表示开启gprof功能, ``--logdir=Debug`` 则表示最终生成的 ``.rvtrace`` 文件、 ``.gmon`` 文件存存放的路径为当前工程下的Debug目录, ``--cup=n300fd`` 表示当前模拟的cpu核是n300fd。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里保留,提示是按照上面的参数说明来进行的配置


.. note::

Live Watch功能依赖OpenOCD和telnet,仅支持使OpenOCD调试程序并开启了telnet端口的情况下使用Live Watch功能。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

依赖Nuclei OpenOCD >= 2024.12版本。仅支持Nuclei CPU配置了RISC-V SBA功能


- 删除 Live Watch 视图中指定的变量行。

**ReMove All**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里怎么会是大写的ReMove , 应该是 Remove


- Save Data Speed : 设定 Live Watch 数据自动保存的频率,默认为每10分钟保存一次。

**Number Fromat**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fromat -> Format, 其他诸如类似的全局查找下


在Nuclei Studio 2024.12基于Eclipse Cpp 2024-12版本开发此版本。基础的CDT版本,升级到了11.6.1。

升级RISC-V Toolchain、OpenOCD、QEMU版本
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuclei Near Cycle Model版本也升级了,但是这个没有Release Note的链接。就主要是全面支持 Nuclei CPU 200,300,600,900,1000系列的CPU,同时支持Windows和Linux版本。

@fanghuaqi fanghuaqi changed the title Personal/zhangzegang/ide 202412 doc: update document for nuclei studio 2024.12 Jan 7, 2025
在演示示例的Config options中配置了 ``--trace=1 --gprof=1 --logdir=Debug --cpu=n300fd`` , ``--trace=1`` 表示开启rvtrace, ``--gprof=1`` 表示开启gprof功能, ``--logdir=Debug`` 则表示最终生成的 ``.rvtrace`` 文件、 ``.gmon`` 文件存存放的路径为当前工程下的Debug目录, ``--cup=n300fd`` 表示当前模拟的cpu核是n300fd。

关于Nuclei Near Cycle Model的参数具体说明,请参见 `Description of Parameters <https://doc.nucleisys.com/nuclei_tools/xlmodel/intro.html#description-of-parameters>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个链接在内部,他有相对路径。用sphinx的路径。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants