facebookincubator / reindeer

Reindeer is a tool to transform Rust Cargo dependencies into generated Buck build rules
MIT License
184 stars 30 forks source link

Fix install instructions #24

Closed Jake-Shadle closed 1 year ago

Jake-Shadle commented 1 year ago

The install instructions in the README fail with

error: multiple packages with binaries found: reindeer, rust-third-party. When installing a git repository, cargo will always search the entire repo for any Cargo.toml.

This just adds reindeer to the install so the first time experience is better.

facebook-github-bot commented 1 year ago

Hi @Jake-Shadle!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

facebook-github-bot commented 1 year ago

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

shayne-fletcher commented 1 year ago

@Jake-Shadle not sure what's up here. i was unable to reproduce this.

specifically, with cargo 1.70.0

git clone git@github.com:facebookincubator/reindeer.git
cargo install --locked --git https://github.com/facebookincubator/reindeer

worked out of the box and reindeer was installed to ~/.cargo/bin.

fwiw, this command also worked,

cargo install --locked --git https://github.com/facebookincubator/reindeer --bin reindeer

and is consistent with the cargo install docs

update: i see that technically the repo does contain multiple crates and again from the cargo install docs that suggests that a crate argument be supplied as you've done. still don't know why i can't reproduce the failure but adding the crate argument seems reasonable anyway.

facebook-github-bot commented 1 year ago

@shayne-fletcher has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Jake-Shadle commented 1 year ago

I'm on cargo 1.71.1 but can still repro with 1.70.0, so...not sure why you are not seeing it.

~ % cargo +1.70.0 install --locked --git https://github.com/EmbarkStudios/reindeer --branch fix-source-parsing
    Updating git repository `https://github.com/EmbarkStudios/reindeer`
error: multiple packages with binaries found: reindeer, rust-third-party. When installing a git repository, cargo will always search the entire repo for any Cargo.toml.
Please specify a package, e.g. `cargo install --git https://github.com/EmbarkStudios/reindeer reindeer`.
facebook-github-bot commented 1 year ago

@shayne-fletcher merged this pull request in facebookincubator/reindeer@602c0dfe17633642599db1fd200b869d6f1ae5ed.