Skip to content

Commit 0f3af10

Browse files
committed
docs: note user_settings.h requirement for pre-built installs; drop builder-test from table
1 parent 4ef44b0 commit 0f3af10

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ stable 0.3 releases.
6666
| `wolfcrypt-ring-testing` | Integration tests for the ring-compatible API. |
6767
| `wolfcrypt-dpe-conformance` | Cross-validates wolfcrypt-dpe against the caliptra-dpe reference implementation. |
6868
| `links-testing` | Validates the cargo metadata propagation chain. |
69-
| `builder-test` | Tests build script modules as a library. |
7069

7170
## Building
7271

@@ -87,6 +86,21 @@ wolfSSL source discovery (in priority order):
8786
3. `vendored` feature on `wolfcrypt-sys` (default: compile from source)
8887
4. `pkg-config`
8988

89+
### Pre-built installs with `user_settings.h`
90+
91+
If you built wolfSSL with `--enable-usersettings` (i.e. `-DWOLFSSL_USER_SETTINGS`),
92+
the installed `wolfssl/options.h` will define `WOLFSSL_USER_SETTINGS`, causing
93+
`wolfssl/wolfcrypt/settings.h` to `#include "user_settings.h"` at build time.
94+
When using `WOLFSSL_DIR` to point at such an install, `user_settings.h` must be
95+
findable on the include path — copy it into the install's `include/` directory:
96+
97+
```sh
98+
cp /path/to/user_settings.h $WOLFSSL_DIR/include/
99+
```
100+
101+
wolfSSL installs built with plain `./configure` flags (no `--enable-usersettings`)
102+
do not have this requirement; their `options.h` is self-contained.
103+
90104
## FIPS 140-3
91105

92106
These crates expose a `fips` feature flag that enables the wolfSSL FIPS 140-3

0 commit comments

Comments
 (0)