From 2dcdc13dff82ef05bdd8884edb6222d43b4429fa Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Fri, 27 May 2016 16:20:52 -0700 Subject: [PATCH] Remove references to CoreConsoleHost from docs The `src/powershell` project is the new host. --- docs/building/linux.md | 19 ++++++++----------- docs/building/osx.md | 2 +- docs/building/windows-core.md | 24 +++++++++++------------- 3 files changed, 20 insertions(+), 25 deletions(-) diff --git a/docs/building/linux.md b/docs/building/linux.md index 2cf505bb87..d1171794e7 100644 --- a/docs/building/linux.md +++ b/docs/building/linux.md @@ -114,7 +114,7 @@ Start-PSBuild Congratulations! If everything went right, PowerShell is now built. The `Start-PSBuild` script will output the location of the executable: -`./src/Microsoft.PowerShell.CoreConsoleHost/bin/Linux/netcoreapp1.0/ubuntu.14.04-x64/powershell`. +`./src/powershell/bin/Linux/netcoreapp1.0/ubuntu.14.04-x64/powershell`. You can run our cross-platform Pester tests with `Start-PSPester`, and our xUnit tests with `Start-PSxUnit`. @@ -138,23 +138,20 @@ make test popd ``` -This library will be emitted in the `src/Microsoft.PowerShell.CoreConsoleHost` -project, where `dotnet` consumes it as "content" and thus -automatically deploys it. +This library will be emitted in the `src/powershell` project, where `dotnet` +consumes it as "content" and thus automatically deploys it. Build the managed projects -------------------------- -The `Microsoft.PowerShell.CoreConsoleHost` project is the cross-platform host for -PowerShell targetting .NET Core. It is the top level project, so -`dotnet build` transitively builds all its dependencies, and emits a -`powershell` executable. The `--configuration Linux` flag is -necessary to ensure that the preprocessor definition `LINUX` is -defined (see [issue #673][]). +The `powershell` project is the .NET Core PowerShell host. It is the top level +project, so `dotnet build` transitively builds all its dependencies, and emits a +`powershell` executable. The `--configuration Linux` flag is necessary to ensure +that the preprocessor definition `LINUX` is defined (see [issue #673][]). ```sh dotnet restore -cd src/Microsoft.PowerShell.CoreConsoleHost +cd src/powershell dotnet build --configuration Linux ``` diff --git a/docs/building/osx.md b/docs/building/osx.md index ddc94d4737..112fddda90 100644 --- a/docs/building/osx.md +++ b/docs/building/osx.md @@ -78,7 +78,7 @@ module. The output directory will be slightly different because your runtime identifier is different. PowerShell will be at -`./src/Microsoft.PowerShell.CoreConsoleHost/bin/Linux/netcoreapp1.0/osx.10.11-x64/powershell`, +`./src/powershell/bin/Linux/netcoreapp1.0/osx.10.11-x64/powershell`, or `osx.10.10` depending on your operating system version. Note that configration is still `Linux` because it would be silly to make yet another separate configuration when it's used soley to work-around a diff --git a/docs/building/windows-core.md b/docs/building/windows-core.md index 7534debeda..65851e5785 100644 --- a/docs/building/windows-core.md +++ b/docs/building/windows-core.md @@ -71,22 +71,20 @@ Start-PSBuild ``` Congratulations! If everything went right, PowerShell is now built and -executable as `./src/Microsoft.PowerShell.CoreConsoleHost/bin/Debug/netcoreapp1.0/win10-x64/powershell`. +executable as `./src/powershell/bin/Debug/netcoreapp1.0/win10-x64/powershell`. This location is of the form -`./[project]/bin/[configuration]/[framework]/[rid]/[binary name]`, and -our project is `Microsoft.PowerShell.CoreConsoleHost`, configuration is `Debug` -by default, framework is `netcoreapp1.0`, runtime identifier is -**probably** `win10-x64` (but will depend on your operating system; -don't worry, `dotnet --info` will tell you what it was), and binary -name is `powershell`. The function `Get-PSOutput` will return the path -to the executable; thus you can execute the development copy via `& +`./[project]/bin/[configuration]/[framework]/[rid]/[binary name]`, and our +project is `powershell`, configuration is `Debug` by default, framework is +`netcoreapp1.0`, runtime identifier is **probably** `win10-x64` (but will depend +on your operating system; don't worry, `dotnet --info` will tell you what it +was), and binary name is `powershell`. The function `Get-PSOutput` will return +the path to the executable; thus you can execute the development copy via `& (Get-PSOutput)`. -The `Microsoft.PowerShell.CoreConsoleHost` project is the cross-platform host for -PowerShell targetting .NET Core. It is the top level project, so -`dotnet build` transitively builds all its dependencies, and emits a -`powershell` executable. The cross-platform host has built-in -documentation via `--help`. +The `powershell` project is the .NET Core PowerShell host. It is the top level +project, so `dotnet build` transitively builds all its dependencies, and emits a +`powershell` executable. The cross-platform host has built-in documentation via +`--help`. You can run our cross-platform Pester tests with `Start-PSPester`.