Skip to content

Commit c03b4d8

Browse files
authored
Merge pull request #61 from KronosTheLate/patch-1
Make more explicit the contents of `./.vscode/JuliaSysimage.toml`
2 parents 25ad8ad + 7d40cf1 commit c03b4d8

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/src/userguide/compilesysimage.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,18 @@ This file should be named `./.vscode/JuliaSysimage.toml` and be placed under the
1616

1717
```
1818
[sysimage]
19-
exclude=[] # Additional packages to be exlucded in the system image
20-
statements_files=[] # Precompile statements files to be used, relative to the project folder
21-
execution_files=[] # Precompile execution files to be used, relative to the project folder
19+
exclude=["Pkg1", "Pkg2"] # Additional packages to be exlucded in the system image
20+
statements_files=["relative/path/to/precompile_statements_file.jl", ]
21+
execution_files="relative/path/to/precompile_excecution_file.jl"
2222
```
23+
The packages to be excluded have to be seperated by commas, each with quotation marks and all inside square brackets.
24+
The path should be relative to the currently active folder, which can be selected by the command `File: Open Folder...`. The statement or excecution files can be given as a single relative path, or as a list of relative paths.
25+
26+
The statement files should contain precompile statements of the form `precompile(Tuple{typeof(Base.sin), Float64})`, and the excecution files should contain function calls for which the methods should be compiled.
2327

2428
The build task creates a sysimage that includes all packages in the current Julia environment. This sysimage is saved in the same folder where the `Project.toml` and `Manifest.toml` of the current Julia environment are stored. The name of the sysimage file will be `JuliaSysimage.dll` (Windows) or `JuliaSysimage.so`.
2529

2630
## Using custom sysimages
2731

2832
When the Julia extension starts a new Julia REPL process, the extension first looks for a custom sysimage file for the current Julia environment. The extension then verifies whether the custom sysimage file is up to date by comparing the last modified date of the sysimage file to the last modified date of the `Manifest.toml` file. If an up to date sysimage file exists, the Julia extension automatically starts the Julia REPL process with the custom sysimage loaded.
29-
This requires the `useCustomSysimage` field to be set to `true` in the application settings of the extension.
33+
This requires the `useCustomSysimage` field to be set to `true` in the application settings of the extension.

0 commit comments

Comments
 (0)