Skip to content

Commit 5e6d0ef

Browse files
authored
Some improvements to documentation (#1031)
* list videos talking about BinaryBuilder * JLLs don't define `LIBPATH_env` anymore
1 parent 5116acd commit 5e6d0ef

File tree

3 files changed

+30
-16
lines changed

3 files changed

+30
-16
lines changed

Manifest.toml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[[ArgParse]]
44
deps = ["Logging", "TextWrap"]
5-
git-tree-sha1 = "e928ca0a49f7b0564044b39108c70c160f03e05a"
5+
git-tree-sha1 = "827259207cb0bada7ad160204c65f49585db6a75"
66
uuid = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
7-
version = "1.1.2"
7+
version = "1.1.3"
88

99
[[ArgTools]]
1010
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
@@ -28,9 +28,9 @@ uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
2828

2929
[[BinaryBuilderBase]]
3030
deps = ["CodecZlib", "Downloads", "InteractiveUtils", "JSON", "LibGit2", "Libdl", "Logging", "OutputCollectors", "Pkg", "Random", "SHA", "Scratch", "SimpleBufferStream", "TOML", "Tar", "UUIDs", "p7zip_jll", "pigz_jll"]
31-
git-tree-sha1 = "8a035e7c65c4cfc1bcf9d8801ff72c3a42205999"
31+
git-tree-sha1 = "b7fec8cbc09cfd74ffc0bcba3aaf510501236021"
3232
uuid = "7f725544-6523-48cd-82d1-3fa08ff4056e"
33-
version = "0.5.0"
33+
version = "0.5.1"
3434

3535
[[CodecZlib]]
3636
deps = ["TranscodingStreams", "Zlib_jll"]
@@ -40,9 +40,9 @@ version = "0.7.0"
4040

4141
[[Compat]]
4242
deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "SHA", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
43-
git-tree-sha1 = "919c7f3151e79ff196add81d7f4e45d91bbf420b"
43+
git-tree-sha1 = "4fecfd5485d3c5de4003e19f00c6898cccd40667"
4444
uuid = "34da2185-b29b-5c13-b0c7-acf172513d20"
45-
version = "3.25.0"
45+
version = "3.26.0"
4646

4747
[[DataAPI]]
4848
git-tree-sha1 = "dfb3b7e89e395be1e25c2ad6d7690dc29cc53b1d"
@@ -355,9 +355,9 @@ uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
355355

356356
[[TableTraits]]
357357
deps = ["IteratorInterfaceExtensions"]
358-
git-tree-sha1 = "b1ad568ba658d8cbb3b892ed5380a6f3e781a81e"
358+
git-tree-sha1 = "c06b2f539df1c6efa794486abfb6ed2022561a39"
359359
uuid = "3783bdb8-4a98-5b6b-af9a-565f29a5fe9c"
360-
version = "1.0.0"
360+
version = "1.0.1"
361361

362362
[[Tables]]
363363
deps = ["DataAPI", "DataValueInterfaces", "IteratorInterfaceExtensions", "LinearAlgebra", "TableTraits", "Test"]
@@ -426,10 +426,10 @@ uuid = "07c12ed4-43bc-5495-8a2a-d5838ef8d533"
426426
version = "0.13.0+1"
427427

428428
[[libsodium_jll]]
429-
deps = ["Libdl", "Pkg"]
430-
git-tree-sha1 = "7127f5f40332ccfa43ee07dcd0c4d81a27d9bb23"
429+
deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
430+
git-tree-sha1 = "848ab3d00fe39d6fbc2a8641048f8f272af1c51e"
431431
uuid = "a9144af2-ca23-56d9-984f-0d03f7b5ccf8"
432-
version = "1.0.18+1"
432+
version = "1.0.20+0"
433433

434434
[[nghttp2_jll]]
435435
deps = ["Artifacts", "Libdl"]

docs/src/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,12 @@ If you already have access to the [GitHub Codespaces](https://github.com/feature
5252
## How does this all work?
5353

5454
`BinaryBuilder.jl` wraps a [root filesystem](rootfs.md) that has been carefully constructed so as to provide the set of cross-compilers needed to support the wide array of platforms that Julia runs on. This _RootFS_ is then used as the chroot jail for a sandboxed process which runs within the RootFS as if that were the whole world. The workspace containing input source code and (eventually) output binaries is mounted within the RootFS and environment variables are setup such that the appropriate compilers for a particular target platform are used by build tools.
55+
56+
## Videos and tutorials
57+
58+
BinaryBuilder has been covered in some videos, you may want to check them out if you want to know more about the framework (the date is specified in parentheses, to make it clear how old/new the videos are):
59+
60+
* [10 tips on how to build better binaries](https://www.youtube.com/watch?v=2e0PBGSaQaI): JuliaCon 2018 talk by Elliot Saba introducing an early version of BinaryBuilder (2018-08-09)
61+
* [Introduction to BinaryBuilder.jl](https://www.youtube.com/watch?v=d_h8C4iCzno): live building session by Mosè Giordano (2020-04-10)
62+
* [BinaryBuilder.jl - The Subtle Art of Binaries That Just Work](https://www.youtube.com/watch?v=3IyXsBwqll8): JuliaCon 2020 workshop by Elliot Saba and Mosè Giordano to guide users through the use of BinaryBuilder (2020-07-25)
63+
* [Your first BinaryBuilder.jl recipe with Julia](https://www.youtube.com/watch?v=7fkNcdbt4dg): live building by Miguel Raz Guzmán Macedo (2021-04-07)

docs/src/jll.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,7 @@ variables:
105105
* `LIBPATH`: the value of the environment variable that holds the list of
106106
directories in which to search shared libraries. This has the correct value
107107
for the libraries provided by the current JLL package;
108-
* `LIBPATH_list`: the list of directories in `LIBPATH` as a vector of `String`s;
109-
* `LIBPATH_env`: the name of the environment variable of the search paths of the
110-
shared libraries for the current platform. This is equal to `LD_LIBRARY_PATH`
111-
on Linux and FreeBSD, `DYLD_FALLBACK_LIBRARY_PATH` on macOS, and `PATH` on
112-
Windows;
108+
* `LIBPATH_list`: the list of directories in `LIBPATH` as a vector of `String`s.
113109

114110
The wrapper files for each platform also define the
115111
[`__init__()`](https://docs.julialang.org/en/v1/manual/modules/index.html#Module-initialization-and-precompilation-1)
@@ -123,6 +119,15 @@ JLL package and detailed below. If you want to see a concrete example of a
123119
package providing all the main three products, have a look at
124120
[`Fontconfig_jll.jl`](https://github.com/JuliaBinaryWrappers/Fontconfig_jll.jl/tree/785936d816d1ae65c2a6648f3a6acbfd72535e36).
125121

122+
In addition to the variables defined above by each JLL wrapper, the package
123+
[`JLLWrappers`](https://github.com/JuliaPackaging/JLLWrappers.jl) defines an
124+
additional unexported variable:
125+
126+
* `LIBPATH_env`: the name of the environment variable of the search paths of the
127+
shared libraries for the current platform. This is equal to `LD_LIBRARY_PATH`
128+
on Linux and FreeBSD, `DYLD_FALLBACK_LIBRARY_PATH` on macOS, and `PATH` on
129+
Windows.
130+
126131
In what follows, we will use as an example a builder that has these products:
127132

128133
```julia

0 commit comments

Comments
 (0)