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

chore: Don't produce docs for hugr binary target #1313

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

aborgna-q
Copy link
Collaborator

This avoids the error due to duplicated target names, as the binary hugr has the same name as the main library hugr.

cargo doc showed this warning:

warning: output filename collision.
The bin target `hugr` in package `hugr-cli v0.1.4 (/home/runner/work/hugr/hugr/hugr-cli)` has the same output filename as the lib target `hugr` in package `hugr v0.8.0 (/home/runner/work/hugr/hugr/hugr)`.
Colliding filename is: /home/runner/work/hugr/hugr/target/doc/hugr/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>.

This caused the resulting docs to produce non-deterministic output, with either target overriding the other.
See cargo#6313.

@aborgna-q aborgna-q requested a review from a team as a code owner July 16, 2024 12:23
@aborgna-q aborgna-q requested a review from zrho July 16, 2024 12:23
@aborgna-q aborgna-q changed the title chore: Don't produce docs for hugr-cli binary target chore: Don't produce docs for hugr binary target Jul 16, 2024
Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.24%. Comparing base (afe1a77) to head (19149a3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1313   +/-   ##
=======================================
  Coverage   87.24%   87.24%           
=======================================
  Files         107      107           
  Lines       19586    19586           
  Branches    17322    17322           
=======================================
  Hits        17088    17088           
  Misses       1714     1714           
  Partials      784      784           
Flag Coverage Δ
rust 86.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aborgna-q aborgna-q added this pull request to the merge queue Jul 16, 2024
Merged via the queue into main with commit 9dedf91 Jul 16, 2024
21 checks passed
@aborgna-q aborgna-q deleted the ab/dont-doc-hugr-bin branch July 16, 2024 12:34
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.

2 participants