Update known-issues.md

This commit is contained in:
Zlatko Knezevic 2016-11-15 16:54:56 -08:00 committed by GitHub
parent 7c29c92aa8
commit b86245e1cb

View file

@ -1,6 +1,25 @@
Known issues & workarounds
==========================
- [Preview 2 tooling known issues](#preview-2-tooling-known-issues)
- [OpenSSL dependency on OS X](#openssl-dependency-on-os-x)
- [`brew` refusing to link `openssl`](#brew-refusing-to-link-openssl)
- [Running .NET Core CLI on Nano Server](#running-net-core-cli-on-nano-server)
- [Users of zsh (z shell) don't get `dotnet` on the path after install](#users-of-zsh-z-shell-dont-get-dotnet-on-the-path-after-install)
- [`app.config` file needs to be checked out before publishing](#appconfig-file-needs-to-be-checked-out-before-publishing)
- [`dotnet` commands in the root of the file system fails](#dotnet-commands-in-the-root-of-the-file-system-fails)
- [On dev builds of the tools, restoring default project from dotnet new fails](#on-dev-builds-of-the-tools-restoring-default-project-from-dotnet-new-fails)
- [Running `dotnet` on Debian distributions causes a segmentation fault](#running-dotnet-on-debian-distributions-causes-a-segmentation-fault)
- [Uninstalling/reinstalling the PKG on OS X](#uninstallingreinstalling-the-pkg-on-os-x)
- [Preview 3 tooling known issues](#preview-3-tooling-known-issues)
- [Installing VS 2017 RC or dotnet CLI preview3 prevents Visual Studio 2015 .NET Core tooling from working](#installing-vs-2017-rc-or-dotnet-cli-preview3-prevents-visual-studio-2015-net-core-tooling-from-working)
- [Restore required before using the .NET Core tooling Preview 3](#restore-required-before-using-the-net-core-tooling-preview-3)
- [`dotnet test` has changed from Preview 2 `dotnet test`](#dotnet-test-has-changed-from-preview-2-dotnet-test)
- [What is this document about?](#what-is-this-document-about)
- [What is a "known issue"?](#what-is-a-known-issue)
# Preview 2 tooling known issues
## OpenSSL dependency on OS X
OS X "El Capitan" (10.11) comes with 0.9.8 version of OpenSSL. .NET Core depends on versions >= 1.0.1 of OpenSSL. You can update the version by using [Homebrew](https://brew.sh), [MacPorts](https://www.macports.org/) or manually. The important bit is that you need to have the required OpenSSL version on the path when you work with .NET Core.
@ -9,7 +28,6 @@ With Homebrew, you can run the following commands to get this done:
```console
brew update
brew install openssl
brew link --force openssl
```
Homebrew may also show the following warning:
@ -27,19 +45,6 @@ sudo port -f uninstall openssl @0.9.8
You can verify whether you have the right version using the `openssl version` command from the Terminal.
## Problems using `brew` to link `openssl` after upgrading
Some users have reported problems when using `brew link --force openssl` command to link the upgraded OpenSSL. The error reported is a variation of the below:
```console
Linking /usr/local/Cellar/openssl/1.0.2h_1...
Error: Could not symlink share/man/man5/config.5ssl /usr/local/share/man/man5 is not writable
```
This is due to permissions being set in a certain way on the `/usr` directory on El Capitan. In order to workaround this problem, you need to give your user ownership of the directory and its contents. More information can be found on the following links:
* http://blog.blakesimpson.co.uk/read/89-fix-homebrew-error-usr-local-bin-is-not-writable-on-os-x-el-capitan
* http://stackoverflow.com/questions/26647412/homebrew-could-not-symlink-usr-local-bin-is-not-writable
## `brew` refusing to link `openssl`
```console
@ -49,10 +54,7 @@ deprecated system version while using the headers from the Homebrew version.
Instead, pass the full include/library paths to your compiler e.g.:
-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib
```
This is due to a recent update from `brew` where it refuses to link `openssl`. More information and workaround on the following links:
* https://github.com/Homebrew/brew/pull/597
* http://stackoverflow.com/questions/38670295/brew-refusing-to-link-openssl
This is due to a recent update from `brew` where it refuses to link `openssl`. The installation steps have been updated with instructions on how to deal with this.
## Running .NET Core CLI on Nano Server
@ -82,23 +84,6 @@ ln -s /usr/local/share/dotnet/dotnet /usr/local/bin
**Workaround 2:** edit your `.zshrc` and/or `.zshprofile` files to add the `/usr/local/share/dotnet` to the $PATH.
## Breaking change in Preview 2 apt-get packages that impacts Preview 1 packages
We made a breaking change in the way we package Preview 2 Ubuntu packages that also affects Preview 1 packages. The core of the change is that the host policy is now not packaged together with the host, but separately. This means that when you install Preview 1 packages from our Ubuntu apt-get feed, you will run into the following error message when trying to run any `dotnet` command:
> Failed to resolve library symbol hostfxr_main, error: dotnet: undefined symbol: hostfxr_main
> Segmentation fault (core dumped)
**Issues tracking this:**
* [dotnet/cli#3657](https://github.com/dotnet/cli/issues/3657)
**Affects:** the Preview 1 apt-get packages
**Workaround:** there are two main workarounds:
1. Use the `dotnet-install.sh` script to install the bits you need; ater you install them, do not forget to put them in the $PATH either by symlinking the `dotnet` binary in a global place (e.g. `/usr/local/bin`) or by adding the install directory to the $PATH.
2. Install the Preview 2 of tooling and then use the `sudo apt-get install dotnet-sharedframework-microsoft.netcore.app-1.0.0-rc2-3002702` commands to install the Preview 1 shared framework so that you apps can continue to work.
## `app.config` file needs to be checked out before publishing
If you have an `app.config` file in source control that places locks on local files (such as TFS), you will recieve the following error during publishing:
@ -143,49 +128,13 @@ If a Debian machine is set in a certain way it may cause the native host (`dotne
**Workaround:** make sure that all of the [native pre-requisites](../Documentation/prereqs.md) are installed correctly. You can usually do this by running `apt-get` package manager.
## `dotnet restore` times out on Win7 x64
If you have any virtualization software (so far we've confirmed VMWare and Virtual Box) and you try to use the CLI on a Win7 SP1 x64 machine, `dotnet restore` will be really slow and will eventually time out without doing much restoring. The issue is in the virtual networking adapters that usually get installed with said software.
**Issues tracking this:**
* [#1732](https://github.com/dotnet/cli/issues/1732)
**Affects:** `dotnet restore`
**Workaround:** disable the virtual network interface and do the restore.
## Resolving the Standard library packages
The StdLib package is on a MyGet feed. In order to restore it, a MyGet feed needs to be added
to the NuGet feeds, either locally per application or in a central location.
**Issues tracking this:**
* [#535](https://github.com/dotnet/cli/issues/535)
**Affects:** `dotnet restore`
**Workaround:** update to the latest bits and run `dotnet new` in an empty directory. This will
now drop a `nuget.config` file that you can use in other applications.
If you cannot update, you can use the following `nuget.config`:
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<!--To inherit the global NuGet package sources remove the <clear/> line below -->
<clear />
<add key="dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
<add key="api.nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
```
## Uninstalling/reinstalling the PKG on OS X
OS X doesn't really have an uninstall capacity for PKGs like Windows has for
MSIs. There is, however, a way to remove the bits as well as the "recipe" for
dotnet. More information can be found on [this SuperUser question](http://superuser.com/questions/36567/how-do-i-uninstall-any-apple-pkg-package-file).
# Preview 3 tooling known issues
## Installing VS 2017 RC or dotnet CLI preview3 prevents Visual Studio 2015 .NET Core tooling from working
Symptoms:
Opening a project.json solution in Visual Studio 2015 fails with `error: Error reading '{some root path}\.vs\restore.dg'`
@ -196,6 +145,18 @@ Workaround:
- Run the copied command from this directory
- Reload the project in Visual Studio
## Restore required before using the .NET Core tooling Preview 3
You have to run `dotnet restore` before you try any of the CLI commands in the Preview 3 tooling. The restore call is needed to bring in the needed targets that comprise main functionality of the Preview 3 tooling. You will get the following error if
you don't restore on macOS/Linux machines:
> /usr/local/share/dotnet/sdk/1.0.0-preview3-004056/Microsoft.Common.CurrentVersion.targets(1107,5): error MSB3644: The reference assemblies for framework ".NETFramework,Version=v4.0" were not found. To resolve this, install the SDK or Targeting Pack for this framework version or retarget your application to a version of the framework for which you have the SDK or Targeting Pack installed. Note that assemblies will be resolved from the Global Assembly Cache (GAC) and will be used in place of reference assemblies. Therefore your assembly may not be correctly targeted for the framework you intend.
If you don't get this error on a Windows machine, that is most likely due to the fact that the targeting pack for .NET Framework 4.0 are installed. To be sure that you have the targets, run restore again if you are not sure.
## `dotnet test` has changed from Preview 2 `dotnet test`
As part of the overall Preview 3 work, `dotnet test` command has been been revised and is quite different in usage and behavior then Preview 2 `dotnet test` command. Please consult the official [dotnet test
docs](https://docs.microsoft.com/en-us/dotnet/articles/cli-preview3/tools/dotnet-test) for more information and expect more documentation in coming days.
# What is this document about?
This document outlines the known issues and workarounds for the current state of
the CLI tools. Issues will also have a workaround and affects sections if necessary. You can use this page to
@ -204,3 +165,4 @@ get information and get unblocked.
# What is a "known issue"?
A "known issue" is a major issue that block users in doing their everyday tasks and that affect all or
most of the commands in the CLI tools. If you want to report or see minor issues, you can use the [issues list](https://github.com/dotnet/cli/issues).