Skip to content

Commit 15334fd

Browse files
authored
README.md: update latest -> dev in doc URLs (#1156)
* README.md: update latest -> dev in doc URLs This was changed deprecated in Documenter.jl 0.20.0 and dropped in 0.24.0 * Use docs.binarybuilder.org in URLs Also use @ref for one internal link, and change some links from dev to stable
1 parent a174790 commit 15334fd

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

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

33
[![Build Status](https://dev.azure.com/JuliaPackaging/BinaryBuilder.jl/_apis/build/status/JuliaPackaging.BinaryBuilder.jl?branchName=master)](https://dev.azure.com/JuliaPackaging/BinaryBuilder.jl/_build/latest?definitionId=2&branchName=master) [![codecov.io](http://codecov.io/github/JuliaPackaging/BinaryBuilder.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaPackaging/BinaryBuilder.jl?branch=master)
44

5-
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliapackaging.github.io/BinaryBuilder.jl/stable)
6-
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliapackaging.github.io/BinaryBuilder.jl/latest)
5+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.binarybuilder.org/stable)
6+
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.binarybuilder.org/dev)
77

88
> "Yea, though I walk through the valley of the shadow of death, I will fear no evil"
99
@@ -24,7 +24,7 @@ BinaryBuilder.run_wizard()
2424

2525
4. The output of a build is a JLL package (typically hosted within the [JuliaBinaryWrappers](https://github.com/JuliaBinaryWrappers/) GitHub organization) which can be added to packages just like any other Julia package. The JLL package will export bindings for all products defined within the build recipe.
2626

27-
For more information, see the documentation for this package, viewable either directly in markdown within the [`docs/src`](docs/src) folder within this repository, or [online](https://juliapackaging.github.io/BinaryBuilder.jl/latest).
27+
For more information, see the documentation for this package, viewable either directly in markdown within the [`docs/src`](docs/src) folder within this repository, or [online](https://docs.binarybuilder.org).
2828

2929
# Philosophy
3030

docs/src/build_tips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,9 @@ You need to understand the build process of package you want to compile in order
194194

195195
Generated tarballs should come with the license of the library that you want to install. If at the end of a successful build there is only one directory inside `${WORKSPACE}/srcdir`, BinaryBuilder will look into it for files with typical names for license (like `LICENSE`, `COPYRIGHT`, etc... with some combinations of extensions) and automatically install them to `${prefix}/share/licenses/${SRC_NAME}/`. If in the final tarball there are no files in this directory a warning will be issued, to remind you to provide a license file.
196196

197-
If the license file is not automatically installed (for example because there is more than one directory in `${WORKSPACE}/srcdir` or because the file name doesn't match the expected pattern) you have to manually install the file. In the build script you can use the `install_license` command. See the [Utilities in the build environment](@ref) section below.
197+
If the license file is not automatically installed (for example because there is more than one directory in `${WORKSPACE}/srcdir` or because the file name doesn't match the expected pattern) you have to manually install the file. In the build script you can use the `install_license` command. See the [Utilities in the build environment](@ref utils_build_env) section below.
198198

199-
## Utilities in the build environment
199+
## [Utilities in the build environment](@id utils_build_env)
200200

201201
In addition to the standard Unix tools, in the build environment there are some extra commands provided by BinaryBuilder. Here is a list of some of these commands:
202202

docs/src/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ checking build system type... Invalid configuration `x86_64-linux-musl': system
6363
configure: error: /bin/sh ./config.sub x86_64-linux-musl failed
6464
```
6565

66-
The `BinaryBuilder` environment provides the utility [`update_configure_scripts`](https://juliapackaging.github.io/BinaryBuilder.jl/dev/build_tips/#Utilities-in-the-build-environment-1) to automatically update these scripts, call it before `./configure`:
66+
The `BinaryBuilder` environment provides the utility [`update_configure_scripts`](@ref utils_build_env) to automatically update these scripts, call it before `./configure`:
6767

6868
```sh
6969
update_configure_scripts
@@ -118,7 +118,7 @@ make -j${nproc}
118118
make install
119119
```
120120

121-
See for example the builder for [Giflib](https://github.com/JuliaPackaging/Yggdrasil/blob/78fb3a7b4d00f3bc7fd2b1bcd24e96d6f31d6c4b/G/Giflib/build_tarballs.jl). If you need to regenerate `configure`, you'll probably need to run [`update_configure_scripts`](https://juliapackaging.github.io/BinaryBuilder.jl/dev/build_tips/#Utilities-in-the-build-environment-1) to make other platforms work as well.
121+
See for example the builder for [Giflib](https://github.com/JuliaPackaging/Yggdrasil/blob/78fb3a7b4d00f3bc7fd2b1bcd24e96d6f31d6c4b/G/Giflib/build_tarballs.jl). If you need to regenerate `configure`, you'll probably need to run [`update_configure_scripts`](@ref utils_build_env) to make other platforms work as well.
122122

123123
## FreeBSD
124124

src/AutoBuild.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,7 @@ function build_jll_package(src_name::String,
13471347
end
13481348
println(io)
13491349
println(io)
1350-
println(io,"For more details about JLL packages and how to use them, see `BinaryBuilder.jl` [documentation](https://juliapackaging.github.io/BinaryBuilder.jl/dev/jll/).")
1350+
println(io,"For more details about JLL packages and how to use them, see `BinaryBuilder.jl` [documentation](https://docs.binarybuilder.org/stable/jll/).")
13511351
println(io)
13521352
if length(sources) > 0
13531353
# `sources` can be empty, and it is for some HelloWorld examples

0 commit comments

Comments
 (0)