Skip to content

Commit c909365

Browse files
committed
Update pruning instruction in Readme
1 parent 451c54f commit c909365

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,30 @@ To use a development version of this package, you can choose one of the followin
3838

3939
1. **Change the UUID in the project file and load the package:**
4040

41-
Start `julia` with the flags
41+
Change the UUID line in `Project.toml` as
42+
```diff
43+
- uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
44+
+ uuid = "27e2e46d-f89d-539d-b4ee-838fcccc9c8e"
45+
```
46+
47+
Start `julia` as
4248
```console
43-
julia +nightly --compiled-modules=existing --project
49+
JULIA_PRUNE_OLD_LA=true julia +nightly --compiled-modules=existing --project
4450
```
45-
where it is assumed that one is already within the `LinearAlgebra` directory. Otherwise, adjust
46-
the project path accordingly. The `julia +nightly` command above assumes that `juliaup` is being used
51+
where it is assumed that one is already within the `LinearAlgebra` directory (otherwise, adjust
52+
the project path accordingly). The `julia +nightly` command above assumes that `juliaup` is being used
4753
to launch `julia`, but one may substitute this with the path to the julia executable.
4854

4955
Within the `julia` session, load the `LinearAlgebra` module after pruning the one in the sysimage. This may be done as
5056
```julia
51-
withenv("JULIA_PRUNE_OLD_LA" => "true") do
52-
include("test/prune_old_LA.jl")
53-
end
54-
using LinearAlgebra
57+
include("test/prune_old_LA.jl") && using LinearAlgebra
58+
```
59+
60+
Note that loading the test files in the REPL will automatically carry out the pruning to ensure that the development version of the package is used in the tests.
61+
62+
If you are contributing to the repo using this method, it may be convenient to ignore the local changes to `Project.toml` by running
63+
```console
64+
git update-index --skip-worktree Project.toml
5565
```
5666

5767
2. **Build Julia with the custom `LinearAlgebra` commit:**

0 commit comments

Comments
 (0)