search

fitzgen / bumpalo

A fast bump allocation arena for Rust
https://docs.rs/bumpalo
Apache License 2.0
1.36k stars 111 forks source link

Use `#![doc = include_str!("../README.md")]` instead of `cargo readme` #123

Closed fitzgen closed 2 years ago

fitzgen commented 2 years ago

This makes it easier for contributors, since they don't need to install an external tool anymore. Basically every contributor would forget to do this and it was a major speed bump to contributing to this crate.

Also there aren't checked-in build artifacts in the repo anymore.

fitzgen commented 2 years ago

This might require bumping the MSRV

konsumlamm commented 2 years ago

Can this be merged soon? I'd like to improve the readme / doc comments, but I'd rather wait for this PR, since it also changes the readme.

fitzgen commented 2 years ago

Just waiting on https://github.com/fitzgen/bumpalo/issues/131 so that we can roll all MSRV bumps together at once.

If you want to help push that forward, since it seems to have stalled, then that would help speed up this PR landing.

pointerless commented 2 years ago

This seems to have caused issues with building on my system:

    Compiling bumpalo v3.9.0
  error: unexpected token: 'include_str'
   --> /home/pointerless/.cargo/registry/src/github.com-1ecc6299db9ec823/bumpalo-3.9.0/src/lib.rs:1:10
    |
  1 | #![doc = include_str!("../README.md")]
    |          ^^^^^^^^^^^

  error: aborting due to previous error

  error: could not compile 'bumpalo'.

(I am installing a different package and have no idea how rust works sorry)

fitzgen commented 2 years ago

@pointerless are you using Rust >= 1.54?

pointerless commented 2 years ago

@fitzgen I have just tried again with the rustup bundled cargo and the issue is gone. I must've been using an older version. Cheers