rust-bitcoin-unsafe-fast/api
merge-script d2c9fab460
Merge rust-bitcoin/rust-bitcoin#3765: contrib: check if the user has cargo-public-api
f01f071751 api: document the need of cargo nightly (Jose Storopoli)
ff67eadc7f contributing: clarify API changes (Jose Storopoli)
04852958b9 contrib: check if the user has cargo-public-api (Jose Storopoli)

Pull request description:

  Closes #3764.

  yancyribbens can you test it locally? It works in my end both with and without `cargo-public-api`. Of course without gives the error message that I was supposed to see.

  EDIT: You can run it with `just check-api`.

ACKs for top commit:
  apoelstra:
    ACK f01f071751332bb6aa8b9affa4677f913035de7f; successfully ran local tests
  tcharding:
    ACK f01f071751

Tree-SHA512: 7acf8332731191de47afc02e24c151bc53c1f38685217eccbea1b64c216674f31729ba703e132765cba67183dff95757aa949d653c5cbe538240371c2db52c14
2024-12-16 23:53:49 +00:00
..
hashes Add api text files 2024-12-06 15:20:52 +11:00
io Add api text files 2024-12-06 15:20:52 +11:00
primitives api: Run just check-api 2024-12-12 16:28:49 +11:00
units Merge rust-bitcoin/rust-bitcoin#3740: Add `Weight::to_kwu_ceil` 2024-12-16 18:54:38 +00:00
README.md api: document the need of cargo nightly 2024-12-15 11:42:52 -03:00

README.md

API text files

Each file here lists the public API when built with some set of features enabled. To create these files run ../contrib/check-for-api-changes.sh:

Requires cargo-public-api, install with:

cargo +nightly install cargo-public-api --locked

ref: https://github.com/enselic/cargo-public-api