Skip to content

Add more detail to instructions for local build #1910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 26, 2025
Merged

Add more detail to instructions for local build #1910

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
432a766
Add more detail to local_build instructions
romanlee Nov 25, 2025
d4dc15d
Update docs/src/tutorials/local-build.md
romanlee Nov 26, 2025
3633583
Update docs/src/tutorials/local-build.md
romanlee Nov 26, 2025
851e706
Apply suggestion from @romanlee
giordano Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/src/tutorials/local-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,5 +99,9 @@ Finally, you may have to add the flag `--extraopt "--sandbox_writable_path=/path

## `LocalPreferences.toml` file

At the end of a successfult build, the `build_local.jl` script will create a `LocalPreferences.toml` file (see [`Preferences.jl` documentation](https://juliapackaging.github.io/Preferences.jl/stable/) for more information) in the top-level of the Reactant repository, pointing `libReactantExtra` to the new local build.
If you instantiate this environment Reactant will automatically use the new local build, but if you want to use the local build in a different environment you will have to copy the `LocalPreferences.toml` file (or its content, if you already have a `LocalPreferences.toml` file) to the directory of that environment.
At the end of a successful build, the `build_local.jl` script will create a `LocalPreferences.toml` file (see [`Preferences.jl` documentation](https://juliapackaging.github.io/Preferences.jl/stable/) for more information) in the top-level of the Reactant repository, pointing `libReactantExtra` to the new local build.
If you instantiate this environment, Reactant will automatically use the new local build.

If you want to use the local build in a different environment:
1. copy the `LocalPreferences.toml` file (or its content, if you already have a `LocalPreferences.toml` file) to the directory of that environment, and
2. ensure that `Reactant_jll` is a direct dependency of that environment (i.e., add `Reactant_jll` to your `Project.toml` directly).
Loading