Skip to content

Commit

Permalink
Fix broken docs links (dotnet#1005)
Browse files Browse the repository at this point in the history
* Fix broken docs links in txt/md files under src

* Fix broken docs links found in source code

* Fix broken docs links in workflow docs

* Fix broken docs links in build commands

* Fix broken docs links in HTML resource files

* Update HTTP/SSL stress test docs for local builds

Co-Authored-By: Eirik Tsarpalis <[email protected]>

* Fix a few remaining broken links

Co-authored-by: Eirik Tsarpalis <[email protected]>
  • Loading branch information
jeffhandley and eiriktsarpalis authored Jan 7, 2020
1 parent 578fe57 commit e82f56f
Show file tree
Hide file tree
Showing 32 changed files with 33 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/workflow/requirements/linux-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you are attempting to cross build the CoreCLR runtime for arm/arm64 then use
docker run --rm -v /home/dotnet-bot/runtime/src/coreclr:/coreclr -w /coreclr -e ROOTFS_DIR=/crossrootfs/arm64 mcr.microsoft.com/dotnet-buildtools/prereqs:ubuntu-16.04-cross-arm64-a3ae44b-20180315221921 ./build.sh arm64 cross
```

Note that instructions on building the crossrootfs location can be found at https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/cross-building.md. These instructions are suggested only if there are plans to change the rootfs, or the Docker images for arm/arm64 are insufficient for your build.
Note that instructions on building the crossrootfs location can be found at https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/cross-building.md. These instructions are suggested only if there are plans to change the rootfs, or the Docker images for arm/arm64 are insufficient for your build.

Docker Images
=============
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/build-test.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ if defined __SkipManaged goto SkipManagedBuild
echo %__MsgPrefix%Starting the Managed Tests Build

if not defined VSINSTALLDIR (
echo %__ErrMsgPrefix%%__MsgPrefix%Error: build-test.cmd should be run from a Visual Studio Command Prompt. Please see https://github.com/dotnet/runtime/blob/master/docs/coreclr/project-docs/developer-guide.md for build instructions.
echo %__ErrMsgPrefix%%__MsgPrefix%Error: build-test.cmd should be run from a Visual Studio Command Prompt. Please see https://github.com/dotnet/runtime/tree/master/docs/workflow for build instructions.
exit /b 1
)
set __AppendToLog=false
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/setup_vs_tools.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ echo Visual Studio 2017 or later not found
:call_vs
if not exist "%_VSCOMNTOOLS%" (
echo %__MsgPrefix%Error: Visual Studio 2017 or 2019 required.
echo Please see https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/windows-instructions.md for build instructions.
echo Please see https://github.com/dotnet/runtime/blob/master/docs/workflow/requirements/windows-requirements.md for build instructions.
exit /b 1
)
echo %__MsgPrefix%"%_VSCOMNTOOLS%\VsDevCmd.bat"
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/src/jit/compiler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4119,7 +4119,7 @@ void Compiler::compFunctionTraceEnd(void* methodCodePtr, ULONG methodCodeSize, b
// code:CILJit::compileMethod function.
//
// For an overview of the structure of the JIT, see:
// https://github.com/dotnet/runtime/blob/master/docs/coreclr/botr/ryujit-overview.md
// https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/ryujit-overview.md
//
void Compiler::compCompile(void** methodCodePtr, ULONG* methodCodeSize, JitFlags* compileFlags)
{
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/src/jit/conventions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Coding Conventions" document, that can be used as a template when writing new
comments in the JIT source code. The definitive coding conventions document is
located here:

https://github.com/dotnet/runtime/blob/master/docs/coreclr/coding-guidelines/clr-jit-coding-conventions.md
https://github.com/dotnet/runtime/blob/master/docs/coding-guidelines/clr-jit-coding-conventions.md


********** Section 7.1.5 TODO comments
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/src/vm/eetoprofinterfaceimpl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
// PLEASE READ!
//
// There are strict rules for how to implement ICorProfilerCallback* wrappers. Please read
// https://github.com/dotnet/runtime/blob/master/docs/coreclr/botr/profilability.md
// https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/profilability.md
// to understand the rules and why they exist.
//
// As a reminder, here is a short summary of your responsibilities. Every PUBLIC
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/src/vm/proftoeeinterfaceimpl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
// PLEASE READ!
//
// There are strict rules for how to implement ICorProfilerInfo* methods. Please read
// https://github.com/dotnet/runtime/blob/master/docs/coreclr/botr/profilability.md
// https://github.com/dotnet/runtime/blob/master/docs/design/coreclr/botr/profilability.md
// to understand the rules and why they exist.
//
// As a reminder, here is a short summary of your responsibilities. Every PUBLIC
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/tests/src/JIT/superpmi/runtests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Run CoreCLR OSS tests on Linux or Mac
# Use the instructions here:
# https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/unix-test-instructions.md
# https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/unix-test-instructions.md
#
# Summary:
# 1. On Linux/Mac, in coreclr, ./build.sh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2>
<p>
In order to be able to use .NET Core on OS X, you need to install <b>OpenSSL</b> version <b>1.0.1/1.0.2</b>.
There are many ways to install/update your libssl. Using <a href="https://brew.sh">Homebrew</a> is the easiest.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/osx-instructions.md#openssl">on this page</a>.
You can view the instructions <a href="http://brewformulas.org/Openssl">here</a> or if you're updating, <a href="https://github.com/dotnet/runtime/blob/master/docs/workflow/building/coreclr/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ aspnet/AspNetCore code paths:
- To copy code from aspnet/AspNetCore to dotnet/runtime, set RUNTIME_REPO to the runtime repo root and then run CopyToRuntime.cmd.

## Building dotnet/runtime code:
- https://github.com/dotnet/runtime/blob/master/docs/libraries/building/windows-instructions.md
- https://github.com/dotnet/runtime/blob/master/docs/libraries/project-docs/developer-guide.md
- https://github.com/dotnet/runtime/tree/master/docs/workflow
- Run libraries.cmd from the root once: `PS D:\github\runtime> .\libraries.cmd`
- Build the individual projects:
- `PS D:\github\dotnet\src\libraries\Common\tests> dotnet msbuild /t:rebuild`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Note: the `config.ps1` file has been added to .gitignore to prevent it being upd

### Build the server applications

Prepare the $COREFX_NET_CLIENT_Machine as any Dev station following the instructions at https://github.com/dotnet/runtime/blob/master/docs/libraries/building/windows-instructions.md. Ensure that you can build and test CoreFX on this machine.
Prepare the $COREFX_NET_CLIENT_Machine as any Dev station following the instructions at https://github.com/dotnet/runtime/blob/master/docs/workflow/requirements/windows-requirements.md. Ensure that you can build and test CoreFX on this machine.
In addition, you will also need to install the _Azure development_ workload for Visual Studio 2017.

From a Visual Studio command prompt:
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/Native/build-native.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ if "%VisualStudioVersion%"=="16.0" (
:MissingVersion
:: Can't find VS 2017, 2019
echo Error: Visual Studio 2017 or 2019 required
echo Please see https://github.com/dotnet/runtime/tree/master/docs/libraries/building for build instructions.
echo Please see https://github.com/dotnet/runtime/tree/master/docs/workflow/building/libraries for build instructions.
exit /b 1

:VS2019
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ These tests require dedicated test servers, so they're designed to be run manual

## Prerequisites

- CoreFX building. you need to be able to do a successful build and run the standard tests, [Unix](https://github.com/dotnet/runtime/blob/master/docs/libraries/building/cross-platform-testing.md) or [Windows](https://github.com/dotnet/runtime/blob/master/docs/libraries/building/windows-instructions.md) Use build.cmd for windows and build.sh for Linux to build CoreFX.
- Libraries building. You need to be able to do a successful [build](https://github.com/dotnet/runtime/tree/master/docs/workflow/building/libraries) and [run the standard tests](https://github.com/dotnet/runtime/blob/master/docs/workflow/testing/libraries/testing.md).

**N.B.** if you want to run the EFCore tests later you will need to build -allconfigurations to generate the NuGet packages, build -allconfigurations works only on windows.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ dotnet run -- -help

Note that the stress suite will test the sdk available in the environment,
that is to say it will not necessarily test the implementation of the local runtime repo.
To achieve this, you will need to point your environment to the [`testhost` build](https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/testing-with-corefx.md).
To achieve this, we will first need to build a new sdk from source. This can be done [using docker](https://github.com/dotnet/runtime/blob/master/eng/docker/Readme.md).

### Running using docker-compose

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ dotnet run -- -help

Note that the stress suite will test the sdk available in the environment,
that is to say it will not necessarily test the implementation of the local runtime repo.
To achieve this, you will need to point your environment to the [`testhost` build](https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/testing-with-corefx.md).
To achieve this, we will first need to build a new sdk from source. This can be done [using docker](https://github.com/dotnet/runtime/blob/master/eng/docker/Readme.md).

### Running using docker-compose

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace System.Runtime.InteropServices
/// of the unmanaged function. However, avoiding this transition removes some of the guarantees the runtime
/// provides through a normal P/Invoke. When exiting the managed runtime to enter an unmanaged function the
/// GC must transition from Cooperative mode into Preemptive mode. Full details on these modes can be found at
/// https://github.com/dotnet/runtime/blob/master/docs/coreclr/coding-guidelines/clr-code-guide.md#2.1.8.
/// https://github.com/dotnet/runtime/blob/master/docs/coding-guidelines/clr-code-guide.md#2.1.8.
/// Suppressing the GC transition is an advanced scenario and should not be done without fully understanding
/// potential consequences.
///
Expand Down
Loading

0 comments on commit e82f56f

Please sign in to comment.