Skip to content

Commit c74c541

Browse files
committed
Add env var to docs and update Readme
1 parent 441d49e commit c74c541

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,24 @@ This package performs some type piracy and is also included in the sysimage, whi
3737
To use a development version of this package, you can choose one of the following methods:
3838

3939
1. **Change the UUID in the project file and load the package:**
40-
This approach will produce warnings and may lead to method ambiguities between the development version and the one in the sysimage, but it can be used for basic experimentation.
40+
41+
Start `julia` as
42+
```julia
43+
JULIA_PRUNE_OLD_LA=true julia +nightly --compiled-modules=existing --project
44+
```
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
47+
to launch `julia`, but one may substitute this with the path to the julia executable.
48+
49+
Within the `julia` session, load the `LinearAlgebra` module after pruning the one in the sysimage. This may be done as
50+
```julia
51+
include("test/prune_old_LA.jl") && using LinearAlgebra
52+
```
4153

4254
2. **Build Julia with the custom `LinearAlgebra` commit:**
43-
Modify the commit in `stdlib/LinearAlgebra.version` and build Julia.
55+
56+
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
57+
to `GitHub` or an equivalent platform.
4458

4559
3. **Build a custom sysimage with the new `LinearAlgebra`:**
4660
- Install `PackageCompiler`.

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
ENV["JULIA_PRUNE_OLD_LA"] = "true"
12
include("../test/prune_old_LA.jl")
23

34
using LinearAlgebra

0 commit comments

Comments
 (0)