Skip to content

Commit

Permalink
Merge pull request #374 from lianakoleva/main
Browse files Browse the repository at this point in the history
Update README.md to remove references to *-apply.sh scripts
  • Loading branch information
mjosaarinen authored Feb 16, 2024
2 parents fae53a0 + d69ad6b commit 8d111bb
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,20 @@ After first checking out the `riscv-crypto` repository:
This will clone GCC, Binutils, Newlib, the RISC-V Proxy kernel (PK)
and the RISC-V ISA Simulator (Spike).

It will then checkout known good commits on a new branch
called `riscv-crypto`.

- For each component in the tool-chain, execute the associated
patch application,
configuration,
and
and/or
compilation (plus installation)
script in turn:

- `gcc`/`binutils`
- `binutils`

```sh
${REPO_HOME}/tools/binutils-apply.sh
```

- `gcc`

```sh
${REPO_HOME}/tools/toolchain-conf.sh
Expand All @@ -61,15 +64,13 @@ After first checking out the `riscv-crypto` repository:
- `pk` (the RISC-V proxy kernel):

```sh
${REPO_HOME}/tools/pk-apply.sh
${REPO_HOME}/tools/pk-conf.sh
${REPO_HOME}/tools/pk-build.sh
```

- `spike`:

```sh
${REPO_HOME}/tools/spike-apply.sh
${REPO_HOME}/tools/spike-conf.sh
${REPO_HOME}/tools/spike-build.sh
```
Expand All @@ -81,7 +82,7 @@ After first checking out the `riscv-crypto` repository:

- The architecture the compiler will target is specified
in `${REPO_HOME}/tools/share.sh` as
`TARGET_ARCH, `ARCH_STRING` and `ABI_STRING`.
`TARGET_ARCH`, `ARCH_STRING` and `ABI_STRING`.

- To re-build a repository from scratch, first run the relevant
`${REPO_HOME}/tools/conf-*.sh` script before running the corresponding
Expand All @@ -94,11 +95,8 @@ This section describes the development flow for the `riscv-crypto`
toolchain and simulator patches.

- Assuming a fresh checkout of the `riscv-crypto` repository,
run the [Getting Started](#Getting-Started) steps described above so that
you have a working baseline toolchain installation.
- Running these steps will apply the patches to `binutils`, `gcc` and
`spike` from the corresponding `tools/patch-*.patch` file.
run the steps described above so that you have a working baseline
toolchain installation.

- There are three classes of tool script used to manage the patches:

Expand Down

0 comments on commit 8d111bb

Please sign in to comment.