RFE: add option to specify path to Cargo.lock #5707

ignatenkobrain · 2018-07-11T07:28:22Z

In Fedora we package all crate sources (including tests) in /usr/share/cargo/registry which is not user-writable. However, we would like to run tests for them after installation. There is already option for target-dir and it would be very nice to get option to put Cargo.lock in some other directory so that we could run cargo test from there.

The text was updated successfully, but these errors were encountered:

ignatenkobrain · 2018-07-11T23:11:08Z

@alexcrichton any idea how the option could be named? I'm thinking about making a patch.

alexcrichton · 2018-07-12T15:52:54Z

Perhaps --lockfile-path to mirror --manifest-path?

epage · 2024-07-16T15:47:59Z

We talked about this in the Cargo team meeting and are open to people experimenting with this

CLI flag only, no config, no manifest support
Name: --lockfile-path <path>
Behind -Zunstable-options and docs
- The flag's docs / --help should have (unstable) in them
Looks like it belongs on all commands that take --manifest-path except cargo locate-project
cargo install should make --lockfile-path imply --locked
Must require the file_name be Cargo.lock (like we do for --manifest-path). We can always re-evaluate this in the future
Main question is how this should work if the lockfile or a parent directory is not present
- I would lean towards "create them" rather than "error"

Ifropc · 2024-07-16T23:17:59Z

@rustbot claim

Ifropc · 2024-07-31T04:48:41Z

@epage sorry it took me some time, but the PR is ready for review.
I followed the guideline you posted in your comment (thank you very much!)
1 slight difference is I haven't added --lockfile-path on cargo install yet, as it's not one of the command that takes the --manifest-path.
I think the main usage of the lockfile-path is to enable folks to run commands on readonly folders (and adding it to almost all --manifest-path commands for consistency is a good idea). However, cargo install doesn't really fit into this category, so I doubt there's going to be any demand for that.
That being sad, adding it is very easy (and to be completely honest I just completely missed your suggestion up until I opened the PR), so if you think it'd be a nice addition it's not a problem to add it to the set of supported commands.

weihanglo · 2024-07-31T12:02:38Z

@Ifropc No worry. As --lockfile-path is not going to be insta-stable, that seems fine to me. We can always discuss use cases later.

Add `--lockfile-path` flag This change implements a new `--lockfile-path` proposed in #5707 . Functionality added: - Add `--lockfile-path <PATH>` to all commands that support `manifest-path` with exception of: - `locate-project` (doesn't use lock file) - `verify-project` (is deprecated) - `read-manifest` (doesn't use lock file) - Behind -Zunstable-options and docs - The flag's docs / `--help` has (unstable) in them - `<PATH>` must end with `Cargo.lock`. If specified path doesn't exist (or parent director(ies), create all the parent directories and the lockfile itself Implementation TLDR: add `requested_lockfile_path` into `Workspace` and set it on `workspace(gctx)` call (setting from the context) Update `lockfile.lock_root()` to respect `requested_lockfile_path` (if set) Add test cases covering all affected commands. Tested creating lockfile, reading lockfile, overriding default (`./Cargo.lock`) lockfile, symlink tests. Extra tests for package to make sure pinned versions from path's lockfile are respected (i.e. double check correct lockfile is used) I doubt this flag will be used for any command that's not read-only, but I tried to cover all the commands.

weihanglo · 2024-08-16T14:50:51Z

Most major tasks in #5707 (comment) were addressed via #14326. Below are remaining tasks:

cargo install should make --lockfile-path imply --locked
- #14326 didn't add --lockfile-path to cargo-install. This should be addressed before stabilization.
Shell completions.
- May have conflicts with the GSoC shell completion project.
Feature gate tests. Lockfile path tests (follow-up) #14417
- We forgot to add those tests in #14326.

Open questions before stabilization

How this should work if the lockfile or a parent directory is not present
- In #14326, missing parent directories will be created when Cargo is about to write the lockfile. This minimizes the chance of creating dangling directories.

epage · 2024-08-16T14:57:35Z

Main question is how this should work if the lockfile or a parent directory is not present

Personally, I wouldn't make a checkbox for that. That is enough of an open question that it should be carried forward to stabilization with a call out of what was chosen for the implementation.

May have conflicts with the GSoC shell completion project.

We should not be blocking completion work on that effort. We'll likely have that start as a nightly-only opt-in so we can do acceptance testing on it.

Ifropc · 2024-08-16T18:54:01Z

Thanks for your reviews! I will do the follow ups for cargo install (sorry actually just forgot about it 😅 ) and tests in separate PRs.
As for GSoC shell completion, from my understanding it's an ongoing effort, as of now. I don't see why would it be conflicting with the new flag, but if any help needed I would be happy to be involved!

epage · 2024-08-16T19:37:27Z

As for GSoC shell completion, from my understanding it's an ongoing effort, as of now. I don't see why would it be conflicting with the new flag, but if any help needed I would be happy to be involved!

I believe the intent was to call out the potential for it being throwaway work which it would be if it was close to being merged and stabilized. However, we do not know how close we are to stabilization until we merge and do a couple rounds of call-for-testing, so any completion work that is pending should still be done.

weihanglo · 2024-08-18T15:06:15Z

Close in favor of the tracking issue #14421

alexcrichton added the C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` label Jul 11, 2018

ehuss added the A-lockfile Area: Cargo.lock issues label Apr 6, 2020

alexxroche mentioned this issue Aug 16, 2020

Option to rename Cargo.lock #8624

Closed

alamb mentioned this issue Apr 26, 2021

Workaround for writing Cargo.lock to read-only mounted source directory in docker-compose apache/arrow-rs#36

Closed

weihanglo added the S-needs-design Status: Needs someone to work further on the design for the feature or fix. NOT YET accepted. label May 10, 2023

weihanglo mentioned this issue Jun 1, 2023

cargo publish error #12195

Closed

weihanglo mentioned this issue Jun 17, 2023

fix(embeded): Don't pollute the scripts dir with target/ #12282

Merged

daxpedda mentioned this issue Jan 27, 2024

-Zbuild-std support oli-obk/ui_test#197

Closed

epage mentioned this issue Apr 9, 2024

'cargo metadata' fails on read-only file system #10096

Open

epage added S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review and removed S-needs-design Status: Needs someone to work further on the design for the feature or fix. NOT YET accepted. labels Jul 16, 2024

rustbot assigned Ifropc Jul 16, 2024

epage mentioned this issue Jul 19, 2024

support generic target tables and env variables #9603

Closed

weihanglo mentioned this issue Jul 20, 2024

Rename Cargo.lock #8498

Closed

maxammann mentioned this issue Jul 22, 2024

stdlib is not added to a project dependencies if rust toolchain installed to read-only location (e.g. Nix store) intellij-rust/intellij-rust#7912

Open

Ifropc mentioned this issue Jul 31, 2024

Add --lockfile-path flag #14326

Merged

weihanglo mentioned this issue Aug 3, 2024

Add a way to ignore existing Cargo.lock files. #8504

Closed

weihanglo linked a pull request Aug 18, 2024 that will close this issue

Lockfile path tests (follow-up) #14417

Merged

weihanglo mentioned this issue Aug 18, 2024

Tracking Issue for --lockfile-path #14421

Open

5 tasks

weihanglo closed this as completed Aug 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFE: add option to specify path to Cargo.lock #5707

RFE: add option to specify path to Cargo.lock #5707

ignatenkobrain commented Jul 11, 2018 •

edited by rustbot

Loading

ignatenkobrain commented Jul 11, 2018

alexcrichton commented Jul 12, 2018

epage commented Jul 16, 2024 •

edited

Loading

Ifropc commented Jul 16, 2024

Ifropc commented Jul 31, 2024

weihanglo commented Jul 31, 2024

weihanglo commented Aug 16, 2024 •

edited

Loading

epage commented Aug 16, 2024

Ifropc commented Aug 16, 2024 •

edited

Loading

epage commented Aug 16, 2024

weihanglo commented Aug 18, 2024

RFE: add option to specify path to Cargo.lock #5707

RFE: add option to specify path to Cargo.lock #5707

Comments

ignatenkobrain commented Jul 11, 2018 • edited by rustbot Loading

ignatenkobrain commented Jul 11, 2018

alexcrichton commented Jul 12, 2018

epage commented Jul 16, 2024 • edited Loading

Ifropc commented Jul 16, 2024

Ifropc commented Jul 31, 2024

weihanglo commented Jul 31, 2024

weihanglo commented Aug 16, 2024 • edited Loading

Open questions before stabilization

epage commented Aug 16, 2024

Ifropc commented Aug 16, 2024 • edited Loading

epage commented Aug 16, 2024

weihanglo commented Aug 18, 2024

ignatenkobrain commented Jul 11, 2018 •

edited by rustbot

Loading

epage commented Jul 16, 2024 •

edited

Loading

weihanglo commented Aug 16, 2024 •

edited

Loading

Ifropc commented Aug 16, 2024 •

edited

Loading