milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Merge rust-bitcoin/rust-bitcoin#1126: Remove stale MSRV docs 

fe840f0b42 Fix stale toolchain docs (Tobin C. Harding)
73b506e149 Remove stale MSRV docs (Tobin C. Harding)

Pull request description:

  We have stale docs referring to the old MSRV. We do not need MSRV docs
  in `CONTRIBUTING` because we have them in the README already.

  Fix stale docs by doing:
  - Remove the MSRV docs from readme in favour of `CONTRIBUTING.md`.
  - Add a sentence to the redame pointing readers towards `CONTRIBUTING.md`.
  - Point readers towards `RUSTUP_TOOLCHAIN`

ACKs for top commit:
  apoelstra:
    ACK fe840f0b42
  Kixunil:
    ACK fe840f0b42

Tree-SHA512: 6d3006db7a460e5d7146b73ff4b99dc322d396e65da39f5ea47c4904aa387c8a36e4a8ae707653dbab90096e692bf69918e6c19c4d3d989c85b22dba4dcba904
This commit is contained in:
Andrew Poelstra 2022-07-26 14:18:19 +00:00
parent 92b6211696 fe840f0b42
commit 7a346970d0
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
2 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -128,9 +128,9 @@ PR authors may also find it useful to run the following script locally in order
to check that each of the commits within the PR satisfies the requirements to check that each of the commits within the PR satisfies the requirements
above, before submitting the PR to review: above, before submitting the PR to review:
```shell script ```shell script
BITCOIN_MSRV=1.29.0 ./contrib/test.sh RUSTUP_TOOLCHAIN=1.41.1 ./contrib/test.sh
``` ```
Please replace the value in `BITCOIN_MSRV=1.29.0` with the current MSRV from Please replace the value in `RUSTUP_TOOLCHAIN=1.41.1` with the current MSRV from
[README.md]. [README.md].
NB: Please keep in mind that the script above replaces `Cargo.lock` file, which NB: Please keep in mind that the script above replaces `Cargo.lock` file, which
@ -183,12 +183,6 @@ and [how it is planned to coordinate it with crate refactoring](https://github.c
For the new code it is recommended to follow style of the existing codebase and For the new code it is recommended to follow style of the existing codebase and
avoid any end-line space characters. avoid any end-line space characters.
### MSRV
The Minimal Supported Rust Version (MSRV) is 1.29; it is enforced by our CI.
Later we plan to increase MSRV to support Rust 2018 and you are welcome to check
the [tracking issue](https://github.com/rust-bitcoin/rust-bitcoin/issues/510).
### Naming conventions ### Naming conventions
Naming of data structures/enums and their fields/variants must follow names used Naming of data structures/enums and their fields/variants must follow names used

2
README.md
View File

@ -71,6 +71,8 @@ please join us in
[#bitcoin-rust](https://web.libera.chat/?channel=#bitcoin-rust) on [#bitcoin-rust](https://web.libera.chat/?channel=#bitcoin-rust) on
[libera.chat](https://libera.chat). [libera.chat](https://libera.chat).
For more information please see `./CONTRIBUTING.md`.
## Minimum Supported Rust Version (MSRV) ## Minimum Supported Rust Version (MSRV)
This library should always compile with any combination of features (minus This library should always compile with any combination of features (minus