Rename mscorlib to System.Private.CoreLib in documentation (#15090)

Fixes #15078

diff --git a/Documentation/botr/mscorlib.md b/Documentation/botr/mscorlib.md
index 5b5046e..8086124 100644 (file)
--- a/Documentation/botr/mscorlib.md
+++ b/Documentation/botr/mscorlib.md
@@ -5,7 +5,7 @@ Author: Brian Grunkemeyer ([@briangru](https://github.com/briangru)) - 2006
 
 # Introduction
 
-Mscorlib is the assembly for defining the core parts of the type system, and a good portion of the Base Class Library. Base data types live in this assembly, and it  has a tight coupling with the CLR. Here you will learn exactly how & why mscorlib.dll is special, and the basics about calling into the CLR from managed code via QCall and FCall methods. It also discusses calling from within the CLR into managed code.
+Mscorlib is the assembly for defining the core parts of the type system, and a good portion of the Base Class Library in .NET Framework. It has been renamed to System.Private.CoreLib in .NET Core, though many places in the code and documentation still refer to it as mscorlib. Base data types live in this assembly, and it  has a tight coupling with the CLR. Here you will learn exactly how & why mscorlib.dll is special, and the basics about calling into the CLR from managed code via QCall and FCall methods. It also discusses calling from within the CLR into managed code.
 
 ## Dependencies
 

diff --git a/Documentation/building/cross-building.md b/Documentation/building/cross-building.md
index 261b902..20fe26e 100644 (file)
--- a/Documentation/building/cross-building.md
+++ b/Documentation/building/cross-building.md
@@ -88,48 +88,48 @@ And with:
 As usual the resulting binaries will be found in `bin/Product/BuildOS.BuildArch.BuildType/`
 
 
-Compiling mscorlib for ARM Linux
-================================
+Compiling System.Private.CoreLib for ARM Linux
+==============================================
 
 It is also possible to use a Windows and a Linux machine to build the managed components of CoreCLR for ARM Linux.  This can be useful when the build on the target platform fails, for example due to Mono issues.
 
-Build mscorlib on Windows
--------------------------
+Build System.Private.CoreLib on Windows
+---------------------------------------
 The following instructions assume you are on a Windows machine with a clone of the CoreCLR repo that has a correctly configured [environment](https://github.com/dotnet/coreclr/wiki/Windows-instructions#environment).
 
-To build mscorlib for Linux, run the following command:
+To build System.Private.CoreLib for Linux, run the following command:
 
 ```
 D:\git\coreclr> build.cmd linuxmscorlib arm
 ```
 
-The arguments `freebsdmscorlib` and `osxmscorlib` can be used instead to build mscorlib for FreeBSD or OS X.
+The arguments `freebsdmscorlib` and `osxmscorlib` can be used instead to build System.Private.CoreLib for FreeBSD or OS X.
 
-The output is at bin\Product\<BuildOS>.arm.Debug\mscorlib.dll.
+The output is at bin\Product\<BuildOS>.arm.Debug\System.Private.CoreLib.dll.
 
 
-Build mscorlib on Ubuntu
--------------------------
+Build System.Private.CoreLib on Ubuntu
+--------------------------------------
 The following instructions assume you are on a Linux machine such as Ubuntu 14.04 x86 64bit. 
 
-To build mscorlib for Linux, run the following command:
+To build System.Private.CoreLib for Linux, run the following command:
 
 ```
     lgs@ubuntu ~/git/coreclr/ $ build.sh arm debug verbose -rebuild
 ```
 
-The output is at bin/Product/<BuildOS>.arm.Debug/mscorlib.dll.
+The output is at bin/Product/<BuildOS>.arm.Debug/System.Private.CoreLib.dll.
 
 ```
-    lgs@ubuntu ~/git/coreclr/ $ file ./bin/Product/Linux.arm.Debug/mscorlib.dll 
-    ./bin/Product/Linux.arm.Debug/mscorlib.dll: PE32 executable (DLL) 
+    lgs@ubuntu ~/git/coreclr/ $ file ./bin/Product/Linux.arm.Debug/System.Private.CoreLib.dll 
+    ./bin/Product/Linux.arm.Debug/System.Private.CoreLib.dll: PE32 executable (DLL) 
     (console) ARMv7 Thumb Mono/.Net assembly, for MS Windows
 ```
 
 Building coreclr for Linux ARM Emulator
 =======================================
 
-It is possible to build coreclr binaries (native and mscorlib.dll) and run coreclr unit tests on the Linux ARM Emulator (latest version provided here: [#3805](https://github.com/dotnet/coreclr/issues/3805)).
+It is possible to build coreclr binaries (native and System.Private.CoreLib.dll) and run coreclr unit tests on the Linux ARM Emulator (latest version provided here: [#3805](https://github.com/dotnet/coreclr/issues/3805)).
 The `tests/scripts/arm32_ci_script.sh` script does this.
 
 The following instructions assume that:
@@ -139,7 +139,7 @@ The emulator rootfs is of 4GB size by default. But to enable testing of coreclr
 
 All the following instructions are for the Release mode. Change the commands and files accordingly for the Debug mode.
 
-To just build libcoreclr and mscorlib for the Linux ARM Emulator, run the following command:
+To just build libcoreclr and System.Private.CoreLib for the Linux ARM Emulator, run the following command:
 ```
 prajwal@ubuntu ~/coreclr $ ./tests/scripts/arm32_ci_script.sh \
     --emulatorPath=/opt/linux-arm-emulator \
@@ -148,9 +148,9 @@ prajwal@ubuntu ~/coreclr $ ./tests/scripts/arm32_ci_script.sh \
     --skipTests
 ```
 
-The Linux ARM Emulator is based on soft floating point and thus the native binaries in coreclr are built for the armel architecture. The coreclr binaries generated by the above command (native and mscorlib) can be found at `~/coreclr/bin/Product/Linux.armel.Release`.
+The Linux ARM Emulator is based on soft floating point and thus the native binaries in coreclr are built for the armel architecture. The coreclr binaries generated by the above command (native and System.Private.CoreLib) can be found at `~/coreclr/bin/Product/Linux.armel.Release`.
 
-To build libcoreclr and mscorlib, and run selected coreclr unit tests on the emulator, do the following:
+To build libcoreclr and System.Private.CoreLib, and run selected coreclr unit tests on the emulator, do the following:
 * Download the latest Coreclr unit test binaries (or build on Windows) from here: [Debug](http://dotnet-ci.cloudapp.net/job/dotnet_coreclr/job/master/job/debug_windows_nt_bld/lastSuccessfulBuild/artifact/bin/tests/tests.zip) and [Release](http://dotnet-ci.cloudapp.net/job/dotnet_coreclr/job/master/job/release_windows_nt_bld/lastSuccessfulBuild/artifact/bin/tests/tests.zip).  
 Setup the binaries at `~/coreclr/bin/tests/Windows_NT.x64.Release`.
 * Build corefx binaries for the Emulator as given [here](https://github.com/dotnet/corefx/blob/master/Documentation/building/cross-building.md#building-corefx-for-linux-arm-emulator).  

diff --git a/Documentation/building/crossgen.md b/Documentation/building/crossgen.md
index bf013e2..ff26094 100644 (file)
--- a/Documentation/building/crossgen.md
+++ b/Documentation/building/crossgen.md
@@ -26,22 +26,20 @@ If you do not follow the above rules, you are likely to encounter errors while r
 Using CrossGen
 --------------
 
-In most cases, the build script automatically runs CrossGen to create the native image for `System.Private.CoreLib.dll` and `mscorlib.dll`.
-When this happens, you will find `System.Private.CoreLib.ni.dll` and `mscorlib.ni.dll` in your output directory.
-`System.Private.CoreLib.dll` and `mscorlib.dll` are the MSIL assemblies created by the C# compiler, while `System.Private.CoreLib.ni.dll` and `mscorlib.ni.dll` are the native images that contain CPU-specific code.
-Once the build is done, you only need `System.Private.CoreLib.ni.dll` and `mscorlib.ni.dll` to use CoreCLR.
+In most cases, the build script automatically runs CrossGen to create the native image for `System.Private.CoreLib.dll`.
+When this happens, you will find `System.Private.CoreLib.ni.dll` in your output directory.
+`System.Private.CoreLib.dll` is the MSIL assemblies created by the C# compiler, while `System.Private.CoreLib.ni.dll` is the native images that contain CPU-specific code.
+Once the build is done, you only need `System.Private.CoreLib.ni.dll` to use CoreCLR.
 The original MSIL assemblies are no longer needed by the runtime.
 
-If you installed CoreCLR from a NuGet package, `System.Private.CoreLib.ni.dll` and `mscorlib.ni.dll` are included in the package.
+If you installed CoreCLR from a NuGet package, `System.Private.CoreLib.ni.dll` is included in the package.
 
-If for some reason you did not get `System.Private.CoreLib.dll` or `mscorlib.ni.dll` with the rest of your CoreCLR, you can easily create it yourself using CrossGen.
+If for some reason you did not get `System.Private.CoreLib.dll` with the rest of your CoreCLR, you can easily create it yourself using CrossGen.
 
-If your `System.Private.CoreLib.dll`,  `mscorlib.dll` and JIT compiler (`clrjit.dll` on Windows or `libclrjit.*` on other platforms) are all in the same directory as CrossGen itself, you can compile `System.Private.CoreLib.dll` and `mscorlib.dll` with the following commands (first two commands for Windows, next two commands for other platforms):
+If your `System.Private.CoreLib.dll` and JIT compiler (`clrjit.dll` on Windows or `libclrjit.*` on other platforms) are all in the same directory as CrossGen itself, you can compile `System.Private.CoreLib.dll` with the following commands (first two commands for Windows, next two commands for other platforms):
 
     .\crossgen.exe System.Private.CoreLib.dll
-    .\crossgen.exe mscorlib.dll
     ./crossgen System.Private.CoreLib.dll
-    ./crossgen mscorlib.dll
     
 If your files are scattered in different directories, or if you want to create native images for other assemblies, the command line is slightly more complex:
 

diff --git a/Documentation/building/freebsd-instructions.md b/Documentation/building/freebsd-instructions.md
index c190ce7..e925f6b 100644 (file)
--- a/Documentation/building/freebsd-instructions.md
+++ b/Documentation/building/freebsd-instructions.md
@@ -102,13 +102,13 @@ Build the Framework Managed Components
 
 We don't _yet_ have support for building managed code on FreeBSD, so you'll need a Windows machine with clones of both the CoreCLR and CoreFX projects.
 
-You will build `mscorlib.dll` out of the coreclr repository and the rest of the framework that out of the corefx repository.  For mscorlib (from a regular command prompt window) run:
+You will build `System.Private.CoreLib.dll` out of the coreclr repository and the rest of the framework that out of the corefx repository.  For System.Private.CoreLib (from a regular command prompt window) run:
 
 ```
 D:\git\coreclr> build.cmd freebsdmscorlib
 ```
 
-The output is placed in `bin\Product\FreeBSD.x64.Debug\mscorlib.dll`.  You'll want to copy this to the runtime folder on your FreeBSD machine. (e.g. `~/coreclr-demo/runtime`)
+The output is placed in `bin\Product\FreeBSD.x64.Debug\System.Private.CoreLib.dll`.  You'll want to copy this to the runtime folder on your FreeBSD machine. (e.g. `~/coreclr-demo/runtime`)
 
 For the rest of the framework, you need to pass some special parameters to build.cmd when building out of the CoreFX repository.
 
@@ -126,13 +126,13 @@ After you've done these steps, the runtime directory on FreeBSD should look like
 
 ```
 janhenke@freebsd-frankfurt:~/git/coreclr % ls ~/coreclr-demo/runtime/
-System.Console.dll  System.Diagnostics.Debug.dll  corerun  libcoreclr.so  libcoreclrpal.so  mscorlib.dll
+System.Console.dll  System.Diagnostics.Debug.dll  corerun  libcoreclr.so  libcoreclrpal.so  System.Private.CoreLib.dll
 ```
 
 Download Dependencies
 =====================
 
-The rest of the assemblies you need to run are presently just facades that point to mscorlib.  We can pull these dependencies down via NuGet (which currently requires Mono).
+The rest of the assemblies you need to run are presently just facades that point to System.Private.CoreLib.  We can pull these dependencies down via NuGet (which currently requires Mono).
 
 Create a folder for the packages:
 
@@ -236,7 +236,7 @@ If all works, you should be greeted by a friendly daemon you know well.
 
 Over time, this process will get easier. We will remove the dependency on having to compile managed code on Windows. For example, we are working to get our NuGet packages to include both the Windows and FreeBSD versions of an assembly, so you can simply nuget restore the dependencies. 
 
-Pull Requests to enable building CoreFX and mscorlib on FreeBSD via Mono would be very welcome. A sample that builds Hello World on FreeBSD using the correct references but via XBuild or MonoDevelop would also be great! Some of our processes (e.g. the mscorlib build) rely on Windows specific tools, but we want to figure out how to solve these problems for FreeBSD as well. There's still a lot of work ahead, so if you're interested in helping, we're ready for you!
+A sample that builds Hello World on FreeBSD using the correct references but via XBuild or MonoDevelop would be great! Some of our processes (e.g. the System.Private.CoreLib build) rely on Windows specific tools, but we want to figure out how to solve these problems for FreeBSD as well. There's still a lot of work ahead, so if you're interested in helping, we're ready for you!
 
 
 Run the test suite

diff --git a/Documentation/building/linux-instructions.md b/Documentation/building/linux-instructions.md
index be70efb..7892772 100644 (file)
--- a/Documentation/building/linux-instructions.md
+++ b/Documentation/building/linux-instructions.md
@@ -83,7 +83,7 @@ After the build is completed, there should some files placed in `bin/Product/Lin
 
 * `corerun`: The command line host.  This program loads and starts the CoreCLR runtime and passes the managed program you want to run to it.
 * `libcoreclr.so`: The CoreCLR runtime itself.
-* `mscorlib.dll`: Microsoft Core Library.
+* `System.Private.CoreLib.dll`: Microsoft Core Library.
 
 Build the Framework
 ===================

diff --git a/Documentation/building/netbsd-instructions.md b/Documentation/building/netbsd-instructions.md
index f678286..341b64e 100644 (file)
--- a/Documentation/building/netbsd-instructions.md
+++ b/Documentation/building/netbsd-instructions.md
@@ -103,7 +103,7 @@ Build CoreFX native x64 Debug and the work (build) dir is in /usr/pkgsrc/wip/cor
 cd /usr/pkgsrc/wip/corefx-git && make
 ```
 
-Build CoreCLR Debug x64 on Linux and copy mscorlib.dll from ./bin/Product/Linux.x64.Debug/mscorlib.dll to NetBSD machine under /usr/pkg/CoreCLR:
+Build CoreCLR Debug x64 on Linux and copy System.Private.CoreLib.dll from ./bin/Product/Linux.x64.Debug/System.Private.CoreLib.dll to NetBSD machine under /usr/pkg/CoreCLR:
 
 ```
 ./build.sh mscorlib Debug

diff --git a/Documentation/building/osx-instructions.md b/Documentation/building/osx-instructions.md
index 3c1c3b4..dc01ae4 100644 (file)
--- a/Documentation/building/osx-instructions.md
+++ b/Documentation/building/osx-instructions.md
@@ -95,7 +95,7 @@ After the build is completed, there should some files placed in `bin/Product/OSX
 
 - `corerun`: The command line host. This program loads and starts the CoreCLR runtime and passes the managed program you want to run to it.
 - `libcoreclr.dylib`: The CoreCLR runtime itself.
-- `mscorlib.dll`: Microsoft Core Library.
+- `System.Private.CoreLib.dll`: Microsoft Core Library.
 
 Build the Framework
 ===================