itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify FAQ entry wording about lockfiles

Browse Source 
I received a report that this FAQ entry (and in particular the wording
"across whatever machine") generated some confusion. Reword the FAQ
entry for clarity.
This commit is contained in:
Josh Triplett 2020-12-15 19:38:26 -08:00
parent a3c2627fbc
commit 2af33ae1b0
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/doc/src/faq.md
View File

@ -103,10 +103,11 @@ issue][3].
### Why do binaries have `Cargo.lock` in version control, but not libraries?
The purpose of a `Cargo.lock` is to describe the state of the world at the time
of a successful build. It is then used to provide deterministic builds across
whatever machine is building the package by ensuring that the exact same
dependencies are being compiled.
The purpose of a `Cargo.lock` lockfile is to describe the state of the world at
the time of a successful build. Cargo uses the lockfile to provide
deterministic builds on different times and different systems, by ensuring that
the exact same dependencies and versions are used as when the `Cargo.lock` file
was originally generated.
This property is most desirable from applications and packages which are at the
very end of the dependency chain (binaries). As a result, it is recommended that