Skip to content

Commit 2b679cf

Browse files
authored
Fix Workflow Broken Markdown Links (dotnet#110332)
* Fix Markdown links that broke after the workflow documentation reconsolidation. * Fixed two other links that broke outside the workflow documents. * Changed 'Debian/Ubuntu' to 'Debian and Ubuntu' in the Linux requirements doc because otherwise, I couldn't get the table of contents link to work correctly.
1 parent efd5a63 commit 2b679cf

File tree

8 files changed

+12
-14
lines changed

8 files changed

+12
-14
lines changed

docs/design/features/y2038.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Normally, ABI breaks like this are not a problem for the Linux ecosystem because
2222

2323
### .NET builds
2424

25-
.NET official builds are produced by building the product on a [dedicated set of build images](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/coreclr/linux-instructions.md). The images run Azure Linux 3.0 with an up-to-date cross-compilation toolchain, and also include a root filesystem of an old Linux distribution that provides an old version of glibc (or musl libc), which determines the libc compatibility of our builds.
25+
.NET official builds are produced by building the product on a [dedicated set of build images](https://github.com/dotnet/runtime/blob/main/docs/workflow/using-docker.md#the-official-runtime-docker-images). The images run Azure Linux 3.0 with an up-to-date cross-compilation toolchain, and also include a root filesystem of an old Linux distribution that provides an old version of glibc (or musl libc), which determines the libc compatibility of our builds.
2626

2727
In .NET 8, we [support](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md#libc-compatibility) glibc 2.23 and musl 1.2.2, by building the product with a root filesystem from Ubuntu 16.04 and Alpine 3.13, respectively.
2828

docs/workflow/building/coreclr/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- [The Basics](#the-basics)
44
- [Build Results](#build-results)
55
- [What to do with the Build](#what-to-do-with-the-build)
6-
- [The Core_Root for Testing Your Build](#the-core-root-for-testing-your-build)
6+
- [The Core_Root for Testing Your Build](#the-core\_root-for-testing-your-build)
77
- [The Dev Shipping Packs](#the-dev-shipping-packs)
88
- [Cross Compilation](#cross-compilation)
99
- [Other Features](#other-features)

docs/workflow/building/coreclr/cross-building.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ When it comes to building, Docker offers the most flexibility when it comes to t
146146

147147
### Cross-Compiling for ARM32 and ARM64 with Docker
148148

149-
As mentioned in the [Linux Cross-Building section](#linux-cross-building), the `ROOTFS_DIR` environment variable has to be set to the _crossrootfs_ location. The prereqs Docker images already have _crossrootfs_ built, so you only need to specify it when creating the Docker container by means of the `-e` flag. These locations are specified in the [Docker Images table](/docs/workflow/building/coreclr/linux-instructions.md#docker-images).
149+
As mentioned in the [Linux Cross-Building section](#linux-cross-building), the `ROOTFS_DIR` environment variable has to be set to the _crossrootfs_ location. The prereqs Docker images already have _crossrootfs_ built, so you only need to specify it when creating the Docker container by means of the `-e` flag. These locations are specified in the [Docker Images table](/docs/workflow/using-docker.md#the-official-runtime-docker-images).
150150

151151
In addition, you also have to specify the `--cross` flag with the target architecture. For example, the following command would create a container to build CoreCLR for Linux ARM64:
152152

docs/workflow/requirements/linux-requirements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Requirements to Set Up the Build Environment on Linux
22

33
- [Using your Linux Environment](#using-your-linux-environment)
4-
- [Debian/Ubuntu](#debian/ubuntu)
4+
- [Debian and Ubuntu](#debian-and-ubuntu)
55
- [CMake on Older Versions of Ubuntu and Debian](#cmake-on-older-versions-of-ubuntu-and-debian)
66
- [Clang for WASM](#clang-for-wasm)
77
- [Additional Tools for Cross Building](#additional-tools-for-cross-building)
@@ -28,7 +28,7 @@ eng/common/native/install-dependencies.sh
2828

2929
Note that it is always a good idea to manually double check that all the dependencies were installed correctly if you opt to use the script.
3030

31-
### Debian/Ubuntu
31+
### Debian and Ubuntu
3232

3333
These instructions are written assuming the current *Ubuntu LTS*.
3434

docs/workflow/testing/coreclr/testing.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,12 @@ This guide will walk you through building and running the CoreCLR tests. These a
2424

2525
## Requirements
2626

27-
In order to build CoreCLR tests, you will need to have built the runtime and the libraries (that is, _clr_ and _libs_ subsets). You can find more detailed instructions per platform in their dedicated docs:
27+
In order to build CoreCLR tests, you will need to have built the runtime and the libraries (that is, _clr_ and _libs_ subsets). You can find detailed instructions on how to do it on their respective README's:
2828

29-
* [Windows](/docs/workflow/building/coreclr/windows-instructions.md)
30-
* [macOS](/docs/workflow/building/coreclr/macos-instructions.md)
31-
* [Linux](/docs/workflow/building/coreclr/linux-instructions.md)
29+
* [CoreCLR](/docs/workflow/building/coreclr/README.md)
30+
* [Libraries](/docs/workflow/building/libraries/README.md)
3231

33-
For CoreCLR testing purposes, it is more than enough to simply build the _libs_ subset, as far as it concerns the libraries. If you want to know more in-depth about them, they have their own [libraries dedicated docs section](/docs/workflow/building/libraries/README.md).
32+
For CoreCLR testing purposes, it is more than enough to simply build the _libs_ subset, as far as it concerns the libraries. If you want to know more in-depth about them, they have their own [libraries dedicated docs section](/docs/workflow/building/libraries/).
3433

3534
## Overview
3635

docs/workflow/testing/coreclr/unix-test-instructions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CoreCLR tests
66

77
## Building
88

9-
Build CoreCLR on [Unix](../../building/coreclr/linux-instructions.md).
9+
Build CoreCLR following the instructions in its [main doc](/docs/workflow/building/coreclr/README.md).
1010

1111
## Building the Tests
1212

docs/workflow/testing/libraries/testing.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ cd src\libraries\System.Collections.Immutable\tests
7979
dotnet build /t:Test
8080
```
8181

82-
**NOTE**: if your environment doesn't have the required SDK installed (e.g. inside [Docker container](/docs/workflow/building/coreclr/linux-instructions.md#build-using-docker)),
83-
use `./dotnet.sh`/`.\dotnet.cmd` instead of `dotnet`.
82+
**NOTE**: if your environment doesn't have the required SDK installed (e.g. inside [a Docker container](/docs/workflow/using-docker.md)), use `./dotnet.sh`/`.\dotnet.cmd` instead of `dotnet`.
8483

8584
### Running only certain tests
8685

src/coreclr/nativeaot/docs/containers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The [`releasesapi`](https://github.com/dotnet/dotnet-docker/blob/main/samples/re
1414

1515
For cloud native apps, build and runtime OS typically match, at least if you use multi-stage build. Once you step out of containers (for app delivery), it is more likely that you are delivering binaries that you want to work in more places (like on older Linux distros).
1616

17-
The .NET build has this exact same need. We produce several [container images to enable cross-building](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/coreclr/linux-instructions.md#docker-images).
17+
The .NET build has this exact same need. We produce several [container images to enable cross-building](https://github.com/dotnet/runtime/blob/main/docs/workflow/using-docker.md#the-official-runtime-docker-images).
1818

1919
You can use these images to build native AOT apps which work on distros as old as Ubuntu 16.04. These build images are not supported, but are expected to work (since we use them to build .NET on daily basis).
2020

0 commit comments

Comments
 (0)