Skip to content

Commit 76e280e

Browse files
authored
Update pruning instruction in readme (#1426)
Changing the UUID doesn't appear to be necessary. We may also condense the julia command to make it easier to launch julia with the development version of `LinearAlgebra`.
2 parents 5ea3ed5 + 57c4996 commit 76e280e

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,16 @@ This package performs some type piracy and is also included in the sysimage, whi
1717

1818
To use a development version of this package, you can choose one of the following methods:
1919

20-
1. **Change the UUID in the project file and load the package:**
21-
22-
Change the UUID line in `Project.toml` as
23-
```diff
24-
- uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
25-
+ uuid = "27e2e46d-f89d-539d-b4ee-838fcccc9c8e"
26-
```
20+
1. **Prune the sysimg version and load the package:**
2721

2822
Start `julia` as
2923
```console
30-
JULIA_PRUNE_OLD_LA=true julia +nightly --compiled-modules=existing --project
24+
JULIA_PRUNE_OLD_LA=true julia +nightly --compiled-modules=existing --project -i -e 'include("test/prune_old_LA.jl")'
3125
```
3226
where it is assumed that one is already within the `LinearAlgebra` directory (otherwise, adjust
3327
the project path accordingly). The `julia +nightly` command above assumes that `juliaup` is being used
3428
to launch `julia`, but one may substitute this with the path to the julia executable.
3529

36-
Within the `julia` session, load the `LinearAlgebra` module after pruning the one in the sysimage. This may be done as
37-
```julia
38-
include("test/prune_old_LA.jl") && using LinearAlgebra
39-
```
40-
41-
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.
42-
43-
If you are contributing to the repo using this method, it may be convenient to ignore the local changes to `Project.toml` by running
44-
```console
45-
git update-index --skip-worktree Project.toml
46-
```
47-
4830
2. **Build Julia with the custom `LinearAlgebra` commit:**
4931

5032
Modify the commit in [`stdlib/LinearAlgebra.version`](https://github.com/JuliaLang/julia/blob/master/stdlib/LinearAlgebra.version) and build Julia. This requires one to push the development branch

0 commit comments

Comments
 (0)