Skip to content

Commit 2b617be

Browse files
[documentation] Fix a few typos and add some remarks (#1266)
* [documentation] Fix a few typos and and some remarks * Apply suggestions from code review Co-authored-by: Max Horn <[email protected]> --------- Co-authored-by: Max Horn <[email protected]>
1 parent b69a885 commit 2b617be

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

docs/src/building.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ different meanings:
431431

432432
As a package developer, you may want to test JLL packages locally, or as a binary dependency
433433
developer you may want to easily use custom binaries. Through a combination of `dev`'ing out
434-
the JLL package and creating an `overrides` directory, it is easy to get complete control over
434+
the JLL package and creating an `override` directory, it is easy to get complete control over
435435
the local JLL package state.
436436

437437
## Overriding a prebuilt JLL package's binaries
@@ -471,6 +471,11 @@ the `~/.julia/dev/` directory, but it will not be uploaded anywhere. This is
471471
useful for local testing and validation that the built artifacts are working
472472
with your package.
473473

474+
If you want to build a JLL package only for your current platform,
475+
you can use `platforms = [HostPlatform()]` in the `build_tarball.jl` script.
476+
You can also provide the target triplet `Base.BinaryPlatforms.host_triplet()`
477+
if you run the script in the command line.
478+
474479
## Deploying local builds without recreating the tarballs
475480
Sometimes all tarballs have already been created successfully locally but not
476481
deployed to GitHub. This can happen, e.g., if it is tricky to figure out the

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ If you decide to use this workflow, however, you will need to manually open pull
4747

4848
### GitHub Codespaces
4949

50-
If you already have access to the [GitHub Codespaces](https://github.com/features/codespaces) service, you can use use BinaryBuilder and all the workflows described above in your browser or with Visual Studio Code, on any operating system, including those not natively supported by the package! Head to [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil/) and create a new Codespace.
50+
If you already have access to the [GitHub Codespaces](https://github.com/features/codespaces) service, you can use BinaryBuilder and all the workflows described above in your browser or with Visual Studio Code, on any operating system, including those not natively supported by the package! Head to [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil/) and create a new Codespace.
5151

5252
## How does this all work?
5353

docs/src/jll.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,11 @@ package, depending on whether the package is `dev`'ed or not. The second method
231231
is particularly recommended to system administrator who wants to use system
232232
libraries in place of the libraries in JLL packages.
233233

234+
!!! warning
235+
The `Artifacts.toml` of the overridden JLL packages must have valid url
236+
fields because Julia always installs an artifact for your platform
237+
even if you override it. This impacts locally built JLL packages.
238+
234239
### `dev`'ed JLL packages
235240

236241
In the event that a user wishes to override the content within a `dev`'ed JLL
@@ -306,4 +311,3 @@ Note that the product name is `libbzip2`, but we use `libbzip2_path`.
306311
build. Please open an issue on [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil/)
307312
requesting a new build, or make a pull request to update the relevant
308313
`build_tarballs.jl` script.
309-

0 commit comments

Comments
 (0)