Skip to content

Commit bbf6f51

Browse files
authored
sha2: tweak backend docs (#800)
1 parent 155dbbf commit bbf6f51

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

sha2/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,19 @@ This crate supports the following backends:
6363
- `aarch64-sha2`: uses the AArch64 `sha2` extension, fallbacks to the `soft` backend
6464
if the extension is not available
6565
- `loongarch64-asm`: `asm!`-based implementation for LoongArch64 targets
66-
- `riscv-zknh`: uses the RISC-V `Zknh` scalar crypto extension (experimental)
67-
- `riscv-zknh-compact`: same as `riscv_zknh` but does not unroll rounds (experimental)
66+
- `riscv-zknh`: uses the RISC-V `Zknh` scalar crypto extension. Experimental,
67+
requires Nightly compiler and to enable `Zknh` and `Zbkb` (or `Zbb`)
68+
target features at compile time.
69+
- `riscv-zknh-compact`: same as `riscv-zknh` but does not unroll rounds.
6870
- `wasm32-simd`: uses the WASM `simd128` extension
6971
- `x86-shani`: uses the x86 SHA-NI extension, fallbacks to the `soft` backend
7072
if the extension is not available (SHA-256 only)
7173
- `x86-avx2`: uses the x86 AVX2 extension, fallbacks to the `soft` backend
7274
if the extension is not available (SHA-512 only)
7375

7476
You can force backend selection using the `sha2_backend` configuration flag. It can be enabled
75-
using either environment variable (e.g. `RUSTFLAGS='--cfg sha2_backend="soft"' cargo build`), or
76-
by modifying your `.cargo/config.toml` file. Currently the flag supports the following values:
77-
`soft`, `soft-compact`, `riscv-zknh`, and `riscv-zknh-compact`.
78-
79-
Note that the RISC-V backends are experimental and require Nightly compiler.
77+
using either environment variable (e.g. `RUSTFLAGS='--cfg sha2_backend="soft"'`),
78+
or by modifying your `.cargo/config.toml` file.
8079

8180
## License
8281

0 commit comments

Comments
 (0)