Skip to content

Commit

Permalink
doc: update for 2024.02 release
Browse files Browse the repository at this point in the history
Signed-off-by: Huaqi Fang <[email protected]>
  • Loading branch information
fanghuaqi committed Apr 10, 2024
1 parent 37f6153 commit ae693ab
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 10 deletions.
7 changes: 7 additions & 0 deletions source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ ChangeLog
Nuclei Tools official releases can be found in https://nucleisys.com/download.php#tools, you can download
it from there.

2024.02
-------

This release is a bugfix release for 2023.10, which fix many issues reported by 2023.10.

See https://github.com/Nuclei-Software/nuclei-tool-guide/issues/1

2023.10
-------

Expand Down
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
author = 'Nuclei'

# The short X.Y version
version = '2023.10'
version = '2024.02'

# The full version, including alpha/beta/rc tags
release = '2023.10'
release = '2024.02'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion source/ide/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Introduction

Currently documentation is still yet ready in English version, please check Chinese version below:

- Nuclei Studio User Guide: https://nucleisys.com/upload/files/doc/nucleistudio/Nuclei_Studio_User_Guide.202310.pdf
- Nuclei Studio User Guide: https://nucleisys.com/upload/files/doc/nucleistudio/Nuclei_Studio_User_Guide.202402.pdf
- Nuclei Studio FAQ: https://nuclei-software.github.io/nuclei-studio

About Nuclei Studio
Expand Down
6 changes: 3 additions & 3 deletions source/openocd/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Repository and Doc

**openocd**

- github riscv-openocd: https://github.com/riscv-mcu/riscv-openocd/tree/nuclei/2023.10
- github riscv-openocd: https://github.com/riscv-mcu/riscv-openocd/tree/nuclei/2024

- gitee riscv-openocd: https://gitee.com/riscv-mcu/riscv-openocd/tree/nuclei/2023.10
- gitee riscv-openocd: https://gitee.com/riscv-mcu/riscv-openocd/tree/nuclei/2024

**openflashloader**

Expand Down Expand Up @@ -100,7 +100,7 @@ openflashloader to achieve the desired results.

.. rubric:: Nuclei Customized CSRs

Nuclei released openocd supports a number of nuclei customized CSRs, please check here https://github.com/riscv-mcu/riscv-openocd/blob/nuclei/2023.10/src/target/riscv/encoding.h#L3109-L3223
Nuclei released openocd supports a number of nuclei customized CSRs, please check here https://github.com/riscv-mcu/riscv-openocd/blob/nuclei/2024/src/target/riscv/encoding.h#L3109-L3223

.. rubric:: Nuclei embedded trace

Expand Down
2 changes: 1 addition & 1 deletion source/qemu/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ If you want to use QEMU on Nuclei-SDK, entry to the ``nuclei-sdk/application/bar
Where **ARCH_EXT** can be used to pass the extension name.
Under normal circumstances, you should see the final output ``NMSIS_TEST_PASS``, which indicates that all test cases have passed successfully.

And Nuclei QEMU and Nuclei SDK are deeply integrated in Nuclei Studio, you can also use it in Nuclei Studio, see https://nucleisys.com/upload/files/doc/nucleistudio/Nuclei_Studio_User_Guide.202310.pdf
And Nuclei QEMU and Nuclei SDK are deeply integrated in Nuclei Studio, you can also use it in Nuclei Studio, see https://nucleisys.com/upload/files/doc/nucleistudio/Nuclei_Studio_User_Guide.202402.pdf

Use Nuclei QEMU in Nuclei Linux SDK
===================================
Expand Down
6 changes: 3 additions & 3 deletions source/toolchain/gnu/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ About GNU Toolchain
===================

The official toolchain repository is located at https://github.com/riscv-collab/riscv-gnu-toolchain.git.
Nuclei maintained toolchain repo is located at https://github.com/riscv-mcu/riscv-gnu-toolchain, and the branch is ``nuclei/2023``, in which the tools included versions are: gcc13, binutils2.40, gdb13.2, and also have merged some important patches from their upstream, as well as additional support for Nuclei custom extensions and pipelines, etc.
Nuclei maintained toolchain repo is located at https://github.com/riscv-mcu/riscv-gnu-toolchain, and the branch is ``nuclei/2024``, in which the tools included versions are: gcc13, binutils2.40, gdb13.2, and also have merged some important patches from their upstream, as well as additional support for Nuclei custom extensions and pipelines, etc.

Extensions Support
==================
Expand Down Expand Up @@ -175,11 +175,11 @@ Install and Setup

.. rubric:: Build Toolchain

For more information about how to build a toolchain, see https://github.com/riscv-mcu/riscv-gnu-toolchain/tree/nuclei/2023/scripts/toolchain. (Only for Nuclei internal use, no technical support is provided)
For more information about how to build a toolchain, see https://github.com/riscv-mcu/riscv-gnu-toolchain/tree/nuclei/2024/scripts/toolchain. (Only for Nuclei internal use, no technical support is provided)

.. rubric:: Development

The process of user compilation and development can see from https://github.com/riscv-mcu/riscv-gnu-toolchain/blob/nuclei/2023/README.md. To get other technical support, please send issues directly to the upstream repository https://github.com/riscv-collab/riscv-gnu-toolchain.
The process of user compilation and development can see from https://github.com/riscv-mcu/riscv-gnu-toolchain/blob/nuclei/2024/README.md. To get other technical support, please send issues directly to the upstream repository https://github.com/riscv-collab/riscv-gnu-toolchain.

.. rubric:: Examples

Expand Down

0 comments on commit ae693ab

Please sign in to comment.