Skip to content

Commit de42302

Browse files
committed
Auto merge of #8978 - joshtriplett:faq-clarification, r=Eh2406
Clarify FAQ entry wording about lockfiles 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.
2 parents a3c2627 + 2af33ae commit de42302

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/doc/src/faq.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,11 @@ issue][3].
103103

104104
### Why do binaries have `Cargo.lock` in version control, but not libraries?
105105

106-
The purpose of a `Cargo.lock` is to describe the state of the world at the time
107-
of a successful build. It is then used to provide deterministic builds across
108-
whatever machine is building the package by ensuring that the exact same
109-
dependencies are being compiled.
106+
The purpose of a `Cargo.lock` lockfile is to describe the state of the world at
107+
the time of a successful build. Cargo uses the lockfile to provide
108+
deterministic builds on different times and different systems, by ensuring that
109+
the exact same dependencies and versions are used as when the `Cargo.lock` file
110+
was originally generated.
110111

111112
This property is most desirable from applications and packages which are at the
112113
very end of the dependency chain (binaries). As a result, it is recommended that

0 commit comments

Comments
 (0)