Skip to content

Libcprover-rust has no README when published in crates.io #7667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
NlightNFotis opened this issue Apr 14, 2023 · 0 comments · Fixed by #7668
Closed

Libcprover-rust has no README when published in crates.io #7667

NlightNFotis opened this issue Apr 14, 2023 · 0 comments · Fixed by #7668
Assignees
@NlightNFotis
Labels
bug Rust API Issues pertaining to the CBCM Rust API

Comments

@NlightNFotis
Copy link
Contributor

NlightNFotis commented Apr 14, 2023 •
edited
Loading

On the latest release of the libcprover-rust crate, the crates.io website doesn't render the documentation, claiming that the project doesn't contain a README.md file.

This is happening because our project contains a readme.md file instead.

The releases were being made from a MacOS machine up until now, which didn't make this a problem (because the OS X filesystem isn't case sensitive by default). Today, we experimentally did a release through a Linux machine, which is case sensitive, rendering this to be a problem.

We're going to fix this very soon, but in the meantime feel free to remedy the situation by:

  1. Looking at the documentation rendered at the previous version's page at crates.io libcprover-rust`, or
  2. Read the documentation locally by rendering it with cargo doc.
@NlightNFotis NlightNFotis added bug Rust API Issues pertaining to the CBCM Rust API labels Apr 14, 2023
@NlightNFotis NlightNFotis self-assigned this Apr 14, 2023
NlightNFotis added a commit to NlightNFotis/cbmc that referenced this issue Apr 14, 2023
@NlightNFotis
Add the readme.md path to the Cargo.toml.
f83c898 
According to the rust documentation at https://doc.rust-lang.org/cargo/reference/manifest.html#the-readme-field,
the default readme file looked up when creating the package is a capitalised
`README.md` (and some others).

Since ours isn't capitalised, we have to explicitly indicate the file
name.

Fixes diffblue#7667.
@NlightNFotis NlightNFotis mentioned this issue Apr 14, 2023
Merged
@github-project-automation github-project-automation bot moved this to Done in Kani API Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NlightNFotis NlightNFotis

Labels
bug Rust API Issues pertaining to the CBCM Rust API
Projects
Kani API
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add the readme.md path to the Cargo.toml. NlightNFotis/cbmc
1 participant
@NlightNFotis