Skip to content

Commit ba27fcf

Browse files
committed
doc: update doc for nuclei toolchain
Signed-off-by: Huaqi Fang <[email protected]>
1 parent 043638d commit ba27fcf

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
RISC-V GNU Compiler Toolchain
22
=============================
33

4+
> Regarding how to build Nuclei RISC-V Toolchain, see [scripts/toolchain/README.md](scripts/toolchain/README.md).
5+
46
This is the RISC-V C and C++ cross-compiler. It supports two build modes:
57
a generic ELF/Newlib toolchain and a more sophisticated Linux-ELF/glibc
68
toolchain.

scripts/toolchain/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# How to build riscv toolchain for Nuclei RISC-V Processor
22

3+
> [!NOTE]
4+
>
5+
> Build a releasable toolchain is a complicated thing, we just shared our script used internally here,> and we don't provide technical support for this script, you should look into the scripts by yourself to understand how it works.
6+
37
This directory contains scripts required for building riscv toolchain
48
of Nuclei RISC-V processor.
59

@@ -11,7 +15,7 @@ for glibc.
1115

1216
## Support Host and Requirements
1317

14-
- Tested on Ubuntu 20.04, real machine not docker environment
18+
- Tested on Ubuntu 20.04 Host, real machine not docker environment
1519
- Git, docker or podman is required
1620
- Good network connection to github, since most source code are pulled from there
1721

@@ -50,6 +54,9 @@ FORCE_SUBMODULE=1 ./scripts/toolchain/prepsrc.sh feature/rvgcc
5054

5155
## Run docker image to build toolchain
5256

57+
> [!WARNING]
58+
> In host environment now
59+
5360
We provide two docker images for build toolchains.
5461

5562
- **gnutoolchain-centos6**: Used to build toolchain for linux host.
@@ -75,6 +82,7 @@ Here assume we are build a linux64 toolchain.
7582

7683
### Build toolchain
7784

85+
> [!WARNING]
7886
> In docker environment now
7987
8088
~~~shell
@@ -101,6 +109,7 @@ DOREBUILD=1 TOOLVER=2024.07-test1 JOBS=32 ./scripts/toolchain/build.sh
101109

102110
### Cleanup toolchain
103111

112+
> [!WARNING]
104113
> In docker environment now
105114
106115
You can cleanup build directories for specified tool version, tool host, tool type, and also clean installed
@@ -114,6 +123,7 @@ TOOLVER=2024.07-eng1 TOOLHOST=linux64 TOOLTYPE=newlibc ./scripts/toolchain/clean
114123

115124
## Release toolchain
116125

126+
> [!WARNING]
117127
> In host environment now, only for Nuclei internal usage
118128
119129
If you want to sync successfully built toolchain to internal share location, you can run it like this.

0 commit comments

Comments
 (0)