Skip to content

Commit fb7d685

Browse files
authored
docs(README.md): fix documentation of features (#252)
1 parent 83c3132 commit fb7d685

File tree

3 files changed

+15
-24
lines changed

3 files changed

+15
-24
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@ where feature detection is not functional.
8989

9090
## Stack usage
9191

92-
Some algorithms use large amounts of stack space. This means that you may need to specify `RUST_MIN_STACK` in your environment.
93-
This for example affects tests.
92+
Some algorithms use large amounts of stack space. This means that you may need
93+
to specify `RUST_MIN_STACK` in your environment. This for example affects
94+
tests.
9495

9596
## Algorithm features
9697

oqs-sys/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This crate provides the unsafe `ffi` bindings to [liboqs][].
77

88
## Features
99

10+
* `vendored` (default): Compile the included version of liboqs instead of linking to the system version.
1011
* `openssl` (default): Compile with OpenSSL features (mostly symmetric cryptography)
1112
* `non_portable`: Don't build a portable library.
1213
* `kems` (default): Compile with all KEMs enabled
@@ -15,16 +16,10 @@ This crate provides the unsafe `ffi` bindings to [liboqs][].
1516
* `frodokem`
1617
* `hqc`
1718
* `kyber`
18-
* `ntru`
1919
* `ntruprime`
20-
* `saber`
21-
* `sidh`
22-
* `sike`
2320
* `sigs` (default): Compile with all signature schemes enabled
2421
* `dilithium`
2522
* `falcon`
26-
* `picnic`
27-
* `rainbow`
2823
* `sphincs`: SPHINCS+
2924

3025
[oqs]: https://openquantumsafe.org

oqs/README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,19 @@ For the ``ffi`` interface bindings, see ``oqs-sys``.
1010

1111
## Features
1212

13-
* `std`: build with `std` support. This adds handly `Display` and `Error` implementations
13+
* `std`: (default) build with `std` support. This adds handly `Display` and `Error` implementations
1414
to relevant types. If you want a `#![no_std]` library, disable this feature (and you
1515
probably want to disable the default features because they pull in OpenSSL through `oqs-sys`).
1616
* `non_portable`: Don't build a portable library.
17+
* `vendored`: (default) Controls the `oqs-sys/vendored` feature which enables building the included version of liboqs.
1718
* `kems` (default): Compile with all KEMs enabled
18-
* `bike` (only on non-Windows)
19-
* `classic_mceliece`
20-
* `frodokem`
21-
* `hqc`
22-
* `kyber`
23-
* `ntru`
24-
* `ntruprime`
25-
* `saber`
26-
* `sidh`
27-
* `sike`
19+
* `bike` (only on non-Windows)
20+
* `classic_mceliece`
21+
* `frodokem`
22+
* `hqc`
23+
* `kyber`
24+
* `ntruprime`
2825
* `sigs` (default): Compile with all signature schemes enabled
29-
* `dilithium`
30-
* `falcon`
31-
* `picnic`
32-
* `rainbow`
33-
* `sphincs`: SPHINCS+
26+
* `dilithium`
27+
* `falcon`
28+
* `sphincs`: SPHINCS+

0 commit comments

Comments
 (0)