Merge rust-bitcoin/rust-bitcoin#1879: embedded: Document how to clean up linker flags

3af9258025 embedded: Document how to clean up linker flags (Tobin C. Harding)

Pull request description:

  Our embedded crate includes instructions to source a shell script that sets the `RUSTFLAGS` env var. Having the env var set like this in ones environment breaks linkage when trying to do "regular" builds.

  Document how to clean up.

ACKs for top commit:
  apoelstra:
    ACK 3af9258025
  Kixunil:
    ACK 3af9258025

Tree-SHA512: 72758fba4dede873da299f01d75fd64b549fe21f954c2720ba3b7fc3c29fd4ed28fd0a749bbe987a7de1551aa32192253dd0033a18c877e877c9960343a5b07c
This commit is contained in:
Andrew Poelstra 2023-05-28 20:54:22 +00:00
commit ce44711219
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 9 additions and 0 deletions

View File

@ -23,3 +23,12 @@ Address: bc1qpx9t9pzzl4qsydmhyt6ctrxxjd4ep549np9993
``` ```
Note that this heap size is required because of the amount of stack used by libsecp256k1 when initializing a context. Note that this heap size is required because of the amount of stack used by libsecp256k1 when initializing a context.
## Cleanup
After sourcing `scripts/env.sh` and _before_ building again using another target
you'll want to unset `RUSTFLAGS` otherwise you'll get linker errors.
```shell
unset RUSTFLAGS
```