Document zcash_note_encryption non-local dependency rationale & doc work-around.
#858
Conversation
…al workspace dependency mgmt.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #858 +/- ##
==========================================
- Coverage 70.12% 70.11% -0.01%
==========================================
Files 125 125
Lines 11862 11862
==========================================
- Hits 8318 8317 -1
- Misses 3544 3545 +1 ☔ View full report in Codecov by Sentry. |
|
I think that rather than change this documentation, and then immediately have to remove it once we remove |
| There is a cross-workspace cyclic dependency: `zcash_client_backend` (local) | ||
| depends on [`orchard`](/~https://github.com/zcash/orchard) which depends on this crate | ||
| `zcash_note_encryption`. For this reason `zcash_client_backend` does not depend on the local | ||
| `zcash_note_encryption` crate, but rather the published crate release. |
There was a problem hiding this comment.
That isn't cyclic, right? The issue is that zcash_client_backend might depend on a different version of zcash_note_encryption to orchard; not that there is any cycle in the dependency graph (which Rust and cargo do not support).
| There is a cross-workspace cyclic dependency: `zcash_client_backend` (local) | |
| depends on [`orchard`](/~https://github.com/zcash/orchard) which depends on this crate | |
| `zcash_note_encryption`. For this reason `zcash_client_backend` does not depend on the local | |
| `zcash_note_encryption` crate, but rather the published crate release. | |
| There is a cross-workspace dependency that requires care with versioning: | |
| `zcash_client_backend` (local) depends on [`orchard`](/~https://github.com/zcash/orchard) | |
| which depends on this crate `zcash_note_encryption`. For this reason `zcash_client_backend` | |
| does not depend on the local `zcash_note_encryption` crate, but rather the published crate | |
| release. |
|
@nathan-at-least this is now conflicted and you have not responded to review, can you please revisit this? |
|
This is obsoleted by #1041. |
I had forgotten about the issue in #768 and just ran
cargo docand was confused by the warning. It took me a bit to track down viacargo tree -i zcash_note_encryption, then I rediscovered #768.So I figured many devs/consumers who are poking around here may also get confused and I added in-band docs about the issue.