Skip to content

Commit

Permalink
Fix up a bunch of repo references in docs (dotnet#60)
Browse files Browse the repository at this point in the history
This is just prelminary, as all of the docs need to be rationalized with each other now that they're all in the same repo.  But it at least keeps most of the links working for now.
  • Loading branch information
stephentoub authored and ViktorHofer committed Nov 15, 2019
1 parent e64a34c commit e90b018
Show file tree
Hide file tree
Showing 49 changed files with 154 additions and 170 deletions.
4 changes: 2 additions & 2 deletions src/coreclr/build-test.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,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/coreclr/blob/master/Documentation/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/blob/master/docs/coreclr/project-docs/developer-guide.md for build instructions.
exit /b 1
)
set __AppendToLog=false
Expand Down Expand Up @@ -647,7 +647,7 @@ of the previous version to "%VSINSTALLDIR%" and then build.
REM DIA SDK not included in Express editions
echo Visual Studio Express does not include the DIA SDK. ^
You need Visual Studio 2017 or 2019 (Community is free).
echo See: https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/developer-guide.md#prerequisites
echo See: https://github.com/dotnet/runtime/blob/master/docs/coreclr/project-docs/developer-guide.md#prerequisites
exit /b 1

:PrecompileFX
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/build.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -1078,5 +1078,5 @@ of the previous version to "%VSINSTALLDIR%" and then build.
REM DIA SDK not included in Express editions
echo Visual Studio Express does not include the DIA SDK. ^
You need Visual Studio 2017 or 2019 (Community is free).
echo See: https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/developer-guide.md#prerequisites
echo See: https://github.com/dotnet/runtime/blob/master/docs/coreclr/project-docs/developer-guide.md#prerequisites
exit /b 1
10 changes: 5 additions & 5 deletions src/coreclr/scripts/superpmi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### An overview of using superpmi.py
-------------------------

General information on [SuperPMI](https://github.com/dotnet/coreclr/blob/master/src/ToolBox/superpmi/readme.txt)
General information on [SuperPMI](https://github.com/dotnet/runtime/blob/master/src/coreclr/ToolBox/superpmi/readme.txt)

------------------------

Expand Down Expand Up @@ -30,11 +30,11 @@ Although SuperPMI has many uses, setup and use of SuperPMI is not always trivial

See the table above for locations of default collections that exist. If there is an mch file that exists, then SuperPMI will automatically download and setup the mch using that location. Please note that, it is possible that the collection is out of date, or there is a jitinterface change which makes the collection invalid. If this is the case, then in order to use the tool a collection will have to be done manually. In order to reproduce the default collections, please see below for what command the default collections are done with.

`/Users/jashoo/coreclr/build.sh x64 checked`
`/Users/jashoo/runtime/src/coreclr/build.sh x64 checked`

`/Users/jashoo/coreclr/build-test.sh x64 checked -priority1`
`/Users/jashoo/runtime/src/coreclr/build-test.sh x64 checked -priority1`

`/Users/jashoo/coreclr/scripts/superpmi.py collect bash "/Users/jashoo/coreclr/tests/runtest.sh x64 checked" --skip-cleanup`
`/Users/jashoo/runtime/src/coreclr/scripts/superpmi.py collect bash "/Users/jashoo/runtime/src/coreclr/tests/runtest.sh x64 checked" --skip-cleanup`

**Collect**

Expand Down Expand Up @@ -63,4 +63,4 @@ SuperPMI replay supports faster assertion checking over a collection than runnin

SuperPMI will take two different JITs, a baseline and diff JIT and run the compiler accross all the methods in the mch file. It uses coredistools to do a binary difference of the two different outputs. Note that sometimes the binary will differ, and SuperPMI will be run once again dumping the asm that was output in text format. Then the text will be diffed, if there are differences, you should look for text differences. If there are some then it is worth investigating the asm differences.

It is worth noting as well that SuperPMI gives more stable instructions retired counters for the JIT.
It is worth noting as well that SuperPMI gives more stable instructions retired counters for the JIT.
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/coreclr/blob/master/Documentation/building/windows-instructions.md for build instructions.
echo Please see https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/windows-instructions.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 @@ -4456,7 +4456,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/coreclr/blob/master/Documentation/botr/ryujit-overview.md
// https://github.com/dotnet/runtime/blob/master/docs/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/coreclr/blob/master/Documentation/coding-guidelines/clr-jit-coding-conventions.md
https://github.com/dotnet/runtime/blob/master/docs/coreclr/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/coreclr/blob/master/Documentation/botr/profilability.md
// https://github.com/dotnet/runtime/blob/master/docs/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/coreclr/blob/master/Documentation/botr/profilability.md
// https://github.com/dotnet/runtime/blob/master/docs/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
4 changes: 2 additions & 2 deletions src/coreclr/tests/runtest.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
# standard please pass the -test_native_bin_location flag to the script.
#
# Use the instructions here:
# https://github.com/dotnet/coreclr/blob/master/Documentation/building/windows-test-instructions.md
# https://github.com/dotnet/coreclr/blob/master/Documentation/building/unix-test-instructions.md
# https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/windows-test-instructions.md
# https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/unix-test-instructions.md
#
################################################################################
################################################################################
Expand Down
6 changes: 3 additions & 3 deletions src/coreclr/tests/src/Interop/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There should be no more than **1** project type per folder (i.e. a folder can co

Ancillary source assets for all tests should be located in `Interop/common` and can be easily added to all managed tests via the `Interop.settings.targets` file or native tests via `Interop.cmake`.

A common pattern for testing is using the `Assert` utilities found in the `CoreFX` repo. This class is part of the `CoreCLRTestLibrary` which is included in all test projects by the `Interop.settings.targets` import. In order to use, add the following `using TestLibrary;` in the relevant test file.
A common pattern for testing is using the `Assert` utilities. This class is part of the `CoreCLRTestLibrary` which is included in all test projects by the `Interop.settings.targets` import. In order to use, add the following `using TestLibrary;` in the relevant test file.

### Managed

Expand Down Expand Up @@ -55,7 +55,7 @@ Testing P/Invoke has two aspects:

### Marshal API

The Marshal API surface area testing is traditionally done via unit testing and far better suited in the [CoreFX](https://github.com/dotnet/corefx/tree/master/src/System.Runtime.InteropServices/tests) repo. Cases where testing the API surface area requires native tests assets will be performed in the [CoreCLR](https://github.com/dotnet/coreclr/tree/master/tests/src/Interop) repo.
The Marshal API surface area testing is traditionally done via unit testing and far better suited in the [library test folder](https://github.com/dotnet/runtime/tree/master/src/libraries/System.Runtime.InteropServices/tests). Cases where testing the API surface area requires native tests assets will be performed in the [coreclr test folder](https://github.com/dotnet/runtime/tree/master/src/coreclr/tests/src/Interop) repo.

### NativeLibrary

Expand All @@ -69,4 +69,4 @@ This series has unit tests corresponding to `System.Runtime.NativeLibrary` APIs

### Adding new managed project
1) The build system automatically discovers managed test projects.
1) Verify project builds by running `build-tests.cmd`/`build-tests.sh` from repo root.
1) Verify project builds by running `build-tests.cmd`/`build-tests.sh` from repo root.
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/coreclr/blob/master/Documentation/building/unix-test-instructions.md
# https://github.com/dotnet/runtime/blob/master/docs/coreclr/building/unix-test-instructions.md
#
# Summary:
# 1. On Linux/Mac, in coreclr, ./build.sh
Expand Down
4 changes: 2 additions & 2 deletions src/installer/corehost/build.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,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/core-setup/tree/master/Documentation/building/windows-instructions.md for build instructions.
echo Please see https://github.com/dotnet/runtime/tree/master/docs/installer/building/windows-instructions.md for build instructions.
exit /b 1

:VS2019
Expand Down Expand Up @@ -124,7 +124,7 @@ of previous version to "%VSINSTALLDIR%" and then resume build.
:: DIA SDK not included in Express editions
echo Visual Studio 2013 Express does not include the DIA SDK. ^
You need Visual Studio 2013+ (Community is free).
echo See: https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/developer-guide.md#prerequisites
echo See: https://github.com/dotnet/runtime/blob/master/docs/coreclr/project-docs/developer-guide.md#prerequisites
exit /b 1

:GenVSSolution
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -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/coreclr/blob/master/Documentation/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/coreclr/building/osx-instructions.md#openssl">on this page</a>.
</p>
</div>
</body>
Expand Down
Loading

0 comments on commit e90b018

Please sign in to comment.