Skip to content

Vendored crates should be checked for changesΒ #5805

Closed

Description

@glandium

I was building Firefox, and tried to do some changes to some rust crate. Doing so made the build fail with something like

error: the listed checksum of ... has changed:
expected: ...
actual: ...

directory sources are not intended to be edited, if modifications are required then it is recommended that [replace] is used with a forked copy of the source

That's an IMO annoying feature of cargo, but this is not what this issue is about. The problem is the following: if I actually build the crate first, and then make the changes, rebuilding just goes on acting as if I had made no change, saying Fresh $crate_name.

It seems to me cargo should fail with the exact same error as if I hadn't already built.

Cc: @alexcrichton

Activity

  1. alexcrichton commented on Jul 26, 2018

    @alexcrichton
    Member

    This is currently expected behavior in that Cargo treats vendored crates like it does crates.io, it doesn't check any mtimes as it assumes it's all read-only. It is a performance optimization to not even look at the filesystem for these crates on incremental builds.

    The correct way to modify a vendored crate is to use [patch] or a path dependency, and Cargo will then correctly handle the crate on incremental rebuilds as it knows that it's not a readonly dependency.

  2. ctrlcctrlv commented on Oct 24, 2022

    @ctrlcctrlv

    The correct way to modify a vendored crate is to use [patch] or a path dependency, and Cargo will then correctly handle the crate on incremental rebuilds as it knows that it's not a readonly dependency.

    Fortunately GNU Guix can bypass this pointless check, as I today discovered.

    https://fredrickbrennan.medium.com/how-to-bypass-rust-cargo-error-directory-sources-are-not-intended-to-be-edited-ab2f257b89da

  3. added a commit that references this issue on Oct 24, 2022
  4. k3d3 commented on Jan 9, 2023

    @k3d3

    When I vendor code into my repository, it changes line endings (and nothing else) which triggers this check. Is there any way to disable or at least mitigate the error in this situation?

  5. ctrlcctrlv commented on Jan 10, 2023

    @ctrlcctrlv

    Does revendor.scm not work for you?

  6. epage commented on Oct 23, 2023

    @epage
    Contributor

    As this is expected behavior and is important for performance reasons, I'm going to propose to the cargo team that we close this.

  7. added
    S-propose-closeStatus: A team member has nominated this for closing, pending further input from the team
    on Oct 23, 2023
  8. weihanglo commented on Dec 22, 2023

    @weihanglo
    Member

    Instead of closing this now, I would like to see an improvement in the cargo-vendor doc. Could document that vendored sources are not intended to be modified, and [patch] is the correct way to do it.

  9. added
    E-easyExperience: Easy
    S-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or review
    and removed
    S-propose-closeStatus: A team member has nominated this for closing, pending further input from the team
    on Dec 22, 2023
  10. briansmith commented on Dec 22, 2023

    @briansmith

    Instead of closing this now, I would like to see an improvement in the cargo-vendor doc. Could document that vendored sources are not intended to be modified, and [patch] is the correct way to do it.

    cargo-vendor should have an option to generate the necessary [patch] for the vendored crates.

  11. LuuuXXX commented on Feb 28, 2024

    @LuuuXXX
    Contributor

    claim first, question it later~ @rustbot claim

  12. added a commit that references this issue on Mar 1, 2024
  13. weihanglo commented on Mar 1, 2024

    @weihanglo
    Member

    #13512 has improved the doc a bit, so I am fine closing this.

    cargo-vendor should have an option to generate the necessary [patch] for the vendored crates.

    @briansmith feel free to open an issue if you have an idea how it would look like. Thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-directory-sourceArea: directory sources (vendoring)A-documenting-cargo-itselfArea: Cargo's documentationCommand-vendorE-easyExperience: EasyS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or review

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions