Skip to content
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.

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

disable cargo doc for subxt-cli #1486

Merged
merged 2 commits into from
Mar 18, 2024
Merged

disable cargo doc for subxt-cli #1486

merged 2 commits into from
Mar 18, 2024

Conversation

niklasad1
Copy link
Member

@niklasad1 niklasad1 commented Mar 18, 2024

Currently we are sometimes running into rust-lang/cargo#6313 because subxt crate and the binary name for subxt-cli causes a file-name collision when running cargo doc.

This PR disables doc for subxt-cli crate which is not that useful anyway. The CLI --help should be sufficient

Fixes the following warning from the cargo doc:

warning: output filename collision.
The bin target `subxt` in package `subxt-cli v0.34.0 (/home/niklasad1/Github/subxt/cli)` has the same output filename as the lib target `subxt` in package `subxt v0.34.0 (/home/niklasad1/Github/subxt/subxt)`.
Colliding filename is: /home/niklasad1/Github/subxt/target/doc/subxt/index.html
The targets should have unique names.
This is a known bug where multiple crates with the same name use
the same path; see <https://github.com/rust-lang/cargo/issues/6313>.

@niklasad1 niklasad1 marked this pull request as ready for review March 18, 2024 14:04
@niklasad1 niklasad1 requested a review from a team as a code owner March 18, 2024 14:04
@niklasad1 niklasad1 changed the title rename subxt to subxt-cli disable docs for `subxt-cli Mar 18, 2024
@niklasad1 niklasad1 changed the title disable docs for `subxt-cli disable cargo doc for subxt-cli Mar 18, 2024
Copy link
Contributor

@tadeohepperle tadeohepperle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jsdw jsdw merged commit 793da7e into master Mar 18, 2024
13 checks passed
@jsdw jsdw deleted the na-subxt-cli-rename-binary branch March 18, 2024 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants