Update and clean up dotnet.md #17183

tdykstra · 2020-02-22T16:57:49Z

Fixes #14122
Fixes #9893
Fixes #8988

Internal review URL

Thraka

Minor things to fix/look at. Looks good.

docs/core/tools/dotnet.md

tdykstra · 2020-02-27T17:31:28Z

@wli3 please review

docs/core/tools/dotnet.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

wli3 · 2020-02-27T21:57:32Z

@vitek-karas could you review this doc? It is mostly about runtime features

wli3 · 2020-02-27T21:57:51Z

From SDK perspective this is good. Although most of them are not SDK features

vitek-karas · 2020-02-28T20:02:31Z

docs/core/tools/dotnet.md

 ```

-# [.NET Core 1.x](#tab/netcore1x)
+To run an application (.NET Core 2.x SDK):


This is not SDK specific - this works even without installed SDK.

vitek-karas · 2020-02-28T20:03:10Z

docs/core/tools/dotnet.md

 ```

-# [.NET Core 2.0](#tab/netcore20)
+To run a command:


This one basically requires SDK - the only command which works without SDK is dotnet exec which is special - and probably can be added to the case below (as it runs an app).

vitek-karas · 2020-02-28T20:03:33Z

docs/core/tools/dotnet.md

- For more information, see [Roll forward](../whats-new/dotnet-core-2-1.md#roll-forward).
-
-`--runtimeconfig`
+To run an application (.NET Core SDK 3.x):


Same as above - not SDK specific.

vitek-karas · 2020-02-28T20:05:22Z

docs/core/tools/dotnet.md


-`--version`
+- It manages .NET Core source code and binaries.


I would not say "manage" that sounds like dotnet is the only way to work with the source code and/or binaries. For example VS/VSCode will handle the source code as well... and running the app is possible with the generated executable instead of dotnet (in fact it's the preferred way for 3.0 and above).

Maybe something like "It provides command to work with .NET Core projects"....

vitek-karas · 2020-02-28T20:06:41Z

docs/core/tools/dotnet.md


-Path containing probing policy and assemblies to probe.
+### SDK options for dotnet by itself


This is not SDK specific - these commands work always, even if SDK is not installed.

vitek-karas · 2020-02-28T20:11:02Z

docs/core/tools/dotnet.md


-Version of the .NET Core runtime to use to run the application.
+  Print out a list of the installed .NET Core runtimes.


Suggested change

Print out a list of the installed .NET Core runtimes.

Prints out a list of the installed .NET Core runtimes.

vitek-karas · 2020-02-28T20:26:43Z

docs/core/tools/dotnet.md


-Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft. Set to `true` to opt-out of the telemetry feature (values `true`, `1`, or `yes` accepted). Otherwise, set to `false` to opt into the telemetry features (values `false`, `0`, or `no` accepted). If not set, the default is `false` and the telemetry feature is active.
+  Specifies the location of the .NET Core SDK and runtimes if they are not installed in the default location. The default location on Windows is `C:\Program Files\dotnet`. The default location on Linux and macOS is `/usr/share/dotnet`.


SDK is optional - so I would word it something like "the location of the .NET Core runtimes and optionally SDKs if they..."

In fact DOTNET_ROOT is only used for running apps via generated executables (apphosts), the muxer dotnet.exe ignores this env. variable. So it really only applies to running apps through executables - has no effect on SDK lookup and dotnet.exe itself`.

There's also DOTNET_ROOT(x86) which is used on 64bit OS when running 32bit executable (instead of DOTNET_ROOT which is the 64bit version that case).

vitek-karas · 2020-02-28T20:42:03Z

docs/core/tools/dotnet.md


-`DOTNET_SERVICING`
+  Specifies whether .NET Core runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to `true`. Set to `false` to not resolve from the global location and have isolated .NET Core installations (values `0` or `false` are accepted). For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/multilevel-sharedfx-lookup.md).


The allowed values are 0 (logical false) and 1 (logical true).

vitek-karas · 2020-02-28T20:52:01Z

docs/core/tools/dotnet.md

-Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft. Set to `true` to opt-out of the telemetry feature (values `true`, `1`, or `yes` accepted). Otherwise, set to `false` to opt into the telemetry features (values `false`, `0`, or `no` accepted). If not set, the default is `false` and the telemetry feature is active.
-
---
+  Sets the language of the CLI UI using a locale value such as `en-us`. The supported values are the same as for Visual Studio. For more information, see the section on changing the installer language in the [Visual Studio installation documentation](https://docs.microsoft.com/visualstudio/install/install-visual-studio?view=vs-2019). The .NET resource manager rules apply, so you don't have to pick an exact match&mdash;you can also pick descendants in the `CultureInfo` tree. For example, if you set it to `fr-CA`, the CLI will find and use the `fr` translations. If you set it to a language that is not supported, the CLI falls back to English.



There are other env. variables supported by dotnet.exe (and the generated executables). Not sure if we should include them all, but for completeness:

DOTNET_DISABLE_GUI_ERRORS - for GUI enabled generated executables - disables dialog popup which normally shows for certain class of errors (only writes to stderr and exits in that case).

DOTNET_ADDITIONAL_DEPS - basically env. variable version of --additional-deps.

DOTNET_RUNTIME_ID - override the detected RID

DOTNET_SHARED_STORE - location of the "shared store" where assembly resolution falls back to in some cases

DOTNET_STARTUP_HOOKS - list of assemblies to load and execute startup hooks from

COREHOST_TRACE, COREHOST_TRACEFILE, COREHOST_TRACE_VERBOSITY - controls diagnostics tracing from the hosting components (dotnet.exe, hostfxr, hostpolicy, ...).

tdykstra · 2020-02-28T22:36:24Z

@wli3 and @vitek-karas Thanks for reviewing!

vitek-karas

LGTM

update and clean up

85cc760

dotnet-bot added this to the February 2020 milestone Feb 22, 2020

dotnet-bot added 📚 Area - .NET Core Guide labels Feb 22, 2020

tdykstra added 3 commits February 22, 2020 10:01

fix link

966b813

misc corrections

6c121f7

corrections

59409db

tdykstra requested a review from Thraka February 24, 2020 23:37

Thraka approved these changes Feb 25, 2020

View reviewed changes

docs/core/tools/dotnet.md Outdated Show resolved Hide resolved

docs/core/tools/dotnet.md Outdated Show resolved Hide resolved

docs/core/tools/dotnet.md Outdated Show resolved Hide resolved

address adegeo feedback

aabb664

tdykstra requested a review from wli3 February 25, 2020 15:38

mairaw reviewed Feb 27, 2020

View reviewed changes

docs/core/tools/dotnet.md Outdated Show resolved Hide resolved

Update docs/core/tools/dotnet.md

6298656

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

vitek-karas reviewed Feb 28, 2020

View reviewed changes

tdykstra added 2 commits February 28, 2020 14:36

address vitek-karas feedback

36e6fd4

fix merge conflict

2c2f69a

vitek-karas approved these changes Feb 28, 2020

View reviewed changes

tdykstra merged commit 9565fb0 into dotnet:master Feb 28, 2020

tdykstra mentioned this pull request Apr 27, 2020

Review dotnet documentation #15506

Closed

BillWagner added dotnet-core/prod cli/subsvc and removed 📚 Area - .NET Core Guide labels Feb 10, 2021


		Path containing probing policy and assemblies to probe.
		### SDK options for dotnet by itself


		Version of the .NET Core runtime to use to run the application.
		Print out a list of the installed .NET Core runtimes.

	Print out a list of the installed .NET Core runtimes.
	Prints out a list of the installed .NET Core runtimes.


		Specifies whether data about the .NET Core tools usage is collected and sent to Microsoft. Set to `true` to opt-out of the telemetry feature (values `true`, `1`, or `yes` accepted). Otherwise, set to `false` to opt into the telemetry features (values `false`, `0`, or `no` accepted). If not set, the default is `false` and the telemetry feature is active.
		Specifies the location of the .NET Core SDK and runtimes if they are not installed in the default location. The default location on Windows is `C:\Program Files\dotnet`. The default location on Linux and macOS is `/usr/share/dotnet`.


		`DOTNET_SERVICING`
		Specifies whether .NET Core runtime, shared framework, or SDK are resolved from the global location. If not set, it defaults to `true`. Set to `false` to not resolve from the global location and have isolated .NET Core installations (values `0` or `false` are accepted). For more information about multi-level lookup, see [Multi-level SharedFX Lookup](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/multilevel-sharedfx-lookup.md).

Update and clean up dotnet.md #17183

Update and clean up dotnet.md #17183

Uh oh!

Conversation

tdykstra commented Feb 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Thraka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tdykstra commented Feb 27, 2020

Uh oh!

Uh oh!

wli3 commented Feb 27, 2020

Uh oh!

wli3 commented Feb 27, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdykstra commented Feb 28, 2020

Uh oh!

vitek-karas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tdykstra commented Feb 22, 2020 •

edited

Loading