Skip to content

Commit 83b6729

Browse files
authored
Remove obsolete information from README.md (#1399)
1 parent 742b601 commit 83b6729

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1374,14 +1374,6 @@ workspace:
13741374
- "arg2"
13751375
- "arg3"
13761376

1377-
# Optional setting to enable the "lockfile". Enabling it will generate
1378-
# a `spago.lock` file with a cache of the build plan.
1379-
# It's disabled by default when using package sets (because we already
1380-
# get a stable build plan from there) and enabled by default when using
1381-
# the Registry solver.
1382-
# See "The lock file" section for more details.
1383-
lock: false
1384-
13851377
# Optional section to further customise the build.
13861378
buildOpts:
13871379
# Directory for the compiler products - optional, defaults to `output`.
@@ -1587,11 +1579,10 @@ package:
15871579
15881580
### The lock file
15891581
1590-
The lock file is a file that Spago can generate to cache the build plan, so that it can be reused in subsequent builds.
1591-
1592-
When using package sets it is disabled by default - since we already get a stable build plan from there - while it's enabled by default when using the Registry solver.
1593-
1594-
You can enable it manually by adding a `lock: true` field to the `workspace` section of your `spago.yaml` file, and that will keep it on regardless of which solving mode you're using.
1582+
The lock file (`spago.lock`) is a file that is generated by Spago in order to
1583+
ensure reproducible builds. It tracks the exact dependency tree of a package
1584+
along with other metadata, such as integrity hashes, and should be committed to
1585+
version control.
15951586

15961587
### File System Paths used in Spago
15971588

0 commit comments

Comments
 (0)