Skip to content

Update .Net Core/SDK docs about version 2.0 to be about version 2.x #7467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 4 commits into from
Aug 30, 2018
Merged

Update .Net Core/SDK docs about version 2.0 to be about version 2.x #7467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff722db
update .net core/sdk docs about version 2.0 to be about version 2.x
bergmeister Aug 6, 2018
83d6cdb
add 2.x to spelling list
bergmeister Aug 7, 2018
f166901
Add 2.x. to the list of allowed spellings
bergmeister Aug 7, 2018
697c037
Address Dan's comment
daxian-dbw Aug 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .spelling
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

#region Global Dictionary
2ae5d07
2.x
2.x.
acl
ActiveDirectory
aditya
Expand Down
2 changes: 1 addition & 1 deletion demos/WindowsPowerShellModules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Existing Windows PowerShell users are familiar with the large number of modules available, however, they are not necessarily compatible with PowerShell Core.
More information regarding compatibility is in a [blog post](https://blogs.msdn.microsoft.com/powershell/2017/07/14/powershell-6-0-roadmap-coreclr-backwards-compatibility-and-more/).

Windows PowerShell 5.1 is based on .Net Framework 4.6.1, while PowerShell Core is based on .Net Core 2.0.
Windows PowerShell 5.1 is based on .Net Framework 4.6.1, while PowerShell Core is based on .Net Core 2.x.
Although both adhere to .Net Standard 2.0 and can be compatible, some modules may be using APIs or cmdlets not supported on CoreCLR or using APIs from Windows PowerShell that have been deprecated and removed from PowerShell Core (for example, PSSnapins).

## Importing a Windows PowerShell module
Expand Down
4 changes: 2 additions & 2 deletions docs/building/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This guide supplements the [Linux instructions](./linux.md), as
building on macOS is almost identical.

.NET Core 2.0 (and by transitivity, us) only supports macOS 10.12+.
.NET Core 2.x (and by transitivity, us) only supports macOS 10.12+.
Copy link
Contributor

@dantraMSFT dantraMSFT Aug 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the third bullet item also need to be changed?

Downloads and installs a preview version of .NET Core SDK 2.0 to ~/.dotnet


## Environment

Expand All @@ -16,7 +16,7 @@ The `Start-PSBootstrap` function does the following:

- Uses `brew` to install CMake, OpenSSL, and GNU WGet
- Uninstalls any prior versions of .NET CLI
- Downloads and installs a preview version of .NET Core SDK 2.0 to `~/.dotnet`
- Downloads and installs .NET Core SDK to `~/.dotnet`

If you want to use `dotnet` outside of `Start-PSBuild`,
add `~/.dotnet` to your `PATH` environment variable.
Expand Down
19 changes: 10 additions & 9 deletions docs/cmdlet-example/command-line-simple-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ different implementations of PowerShell.
to install PowerShell Core for the distribution and version of Linux you're running.
You can get that version info by running the command `lsb_release -a` from the WSL console.

* .NET Core 2.0 SDK
* .NET Core 2.x SDK

Download and install the [.NET Core 2.0 SDK][net-core-sdk] for your operating system.
Download and install the [.NET Core 2.x SDK][net-core-sdk] for your operating system.
It is recommended that you use a package manager to install the SDK on Linux.
See these [instructions][linux-install] on how to install the SDK on Linux.
Be sure to pick your distribution of Linux e.g. RHEL, Debian, etc to get the
Expand All @@ -40,7 +40,7 @@ different implementations of PowerShell.
```

This should output `2.0.0` or higher. If it returns a major version of 1, make sure you have
installed the .NET Core 2.0 SDK and have restarted your shell to get the newer version of
installed the .NET Core 2.x SDK and have restarted your shell to get the newer version of
the SDK tools.

1. Use the `dotnet` CLI to create a starter `classlib` project based on .NET Standard 2.0
Expand Down Expand Up @@ -114,7 +114,7 @@ different implementations of PowerShell.
## Using a .NET Standard 2.0 based binary module in Windows PowerShell

You may have heard that a .NET assembly compiled as a .NET Standard 2.0 class library
will load into both .NET Core 2.0 applications such as PowerShell Core and
will load into both .NET Core 2.x applications such as PowerShell Core and
.NET Framework 4.6.1 (or higher) applications such as Windows PowerShell.
This allows you to build a single, cross-platform binary module.

Expand Down Expand Up @@ -171,14 +171,15 @@ can't find the `netstandard.dll` "implementation" assembly for the version of th

### The fix for missing netstandard.dll
Copy link
Contributor

@dantraMSFT dantraMSFT Aug 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are stale references to 2.0 in this section. Two that stand out are

  • "Install the .NET Core SDK 2.0 for Windows, if it isn't already installed."
    This actually links to the .NET Core 2.1 page. Perhaps updating the link label to also use 2.x

  • Copy-Item 'C:\Program Files\dotnet\sdk\2.0.0\Microsoft...
    A note about the version number varying might help so users arent' blindly copy/pasting the text and getting errors.


If you install (or already have) the .NET Core 2.0 SDK for Windows, you can
If you install (or already have) the .NET Core SDK for Windows, you can
find the `netstandard.dll` implementation assembly for .NET 4.6.1 in the following directory:
`C:\Program Files\dotnet\sdk\2.0.0\Microsoft\Microsoft.NET.Build.Extensions\net461\lib`.
`C:\Program Files\dotnet\sdk\<version-number>\Microsoft\Microsoft.NET.Build.Extensions\net461\lib`.
Note that, the version number in the path may vary depending on the installed SDK.

If you copy `netstandard.dll` from this directory to the directory containing
`MyModule.dll`, the `Write-TimestampedMessage` command will work. Let's try that.

1. Install the [.NET Core SDK 2.0 for Windows][net-core-sdk], if it isn't already installed.
1. Install [.NET Core SDK for Windows][net-core-sdk], if it isn't already installed.

1. Start a new Windows PowerShell console. Remember that once a binary assembly is
loaded into PowerShell it can't be unloaded. Restarting PowerShell is necessary to
Expand All @@ -187,7 +188,7 @@ If you copy `netstandard.dll` from this directory to the directory containing
1. Copy the `netstandard.dll` implementation assembly for .NET 4.6.1 to the module's directory.
```powershell
cd 'path-to-where-you-copied-module.dll'
Copy-Item 'C:\Program Files\dotnet\sdk\2.0.0\Microsoft\Microsoft.NET.Build.Extensions\net461\lib\netstandard.dll' .
Copy-Item 'C:\Program Files\dotnet\sdk\<version-number>\Microsoft\Microsoft.NET.Build.Extensions\net461\lib\netstandard.dll' .
```

1. Import the module and execute the command:
Expand All @@ -211,7 +212,7 @@ class library that will run in PowerShell Core on multiple operating systems.
It will also run in Windows PowerShell on Windows systems that have been updated to
.NET Framework 4.7.1 as well as the Windows 10 Fall Creators Update which comes with that
version pre-installed. Furthermore, this binary module can be built on Linux
and macOS as well as Windows using the .NET Core 2.0 SDK command-line tools.
and macOS as well as Windows using the .NET Core 2.x SDK command-line tools.

For more information on .NET Standard, check out the [documentation][net-std-docs]
and the [.NET Standard YouTube channel][net-std-chan].
Expand Down
2 changes: 1 addition & 1 deletion test/tools/WebListener/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# WebListener App

ASP.NET Core 2.0 app for testing HTTP and HTTPS Requests.
ASP.NET Core app for testing HTTP and HTTPS Requests.

## Run with `dotnet`

Expand Down
2 changes: 1 addition & 1 deletion test/tools/WebListener/WebListener.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<Import Project="..\..\Test.Common.props"/>

<PropertyGroup>
<Description>A simple ASP.NET Core 2.0 MVC app to provide an HTTP and HTTPS server for testing.</Description>
<Description>A simple ASP.NET Core MVC app to provide an HTTP and HTTPS server for testing.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down