Skip to content

Add description and initial guidance for DOTNET_HOST_PATH usage #36383

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
merged 8 commits into from
Aug 3, 2023
Merged

Add description and initial guidance for DOTNET_HOST_PATH usage #36383

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
55f4297
add description and initial guidance for DOTNET_HOST_PATH usage
baronfel Jul 25, 2023
aca6737
update note for apphost-based-execution
baronfel Jul 25, 2023
82da2f3
make it clear that invoking via dotnet doesn't set the DOTNET_HOST_PA…
baronfel Jul 25, 2023
65c9fad
rework based on PR and internal feedback
baronfel Jul 31, 2023
508f6cd
Update docs/core/tools/dotnet-environment-variables.md
baronfel Aug 3, 2023
8de95d4
Update docs/core/tools/dotnet-environment-variables.md
baronfel Aug 3, 2023
5a1fe7f
Update docs/core/tools/dotnet-environment-variables.md
baronfel Aug 3, 2023
c3470c9
Update docs/core/tools/dotnet-environment-variables.md
baronfel Aug 3, 2023
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
12 changes: 12 additions & 0 deletions docs/core/tools/dotnet-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,18 @@ See [EventPipe environment variables](../diagnostics/eventpipe.md#trace-using-en

Specifies the location of the .NET 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/local/share/dotnet`. This environment variable is used only when running apps via generated executables (apphosts). `DOTNET_ROOT(x86)` is used instead when running a 32-bit executable on a 64-bit OS.

### `DOTNET_HOST_PATH`

Specifies the absolute path to a `dotnet` host (`dotnet.exe` on Windows, `dotnet` on Linux and macOS) that was used to launch the currently-running `dotnet` process. This is used by the .NET SDK to help tools that run during .NET SDK commands ensure they use the same `dotnet` runtime for any child `dotnet` processes they create for the duration of the command. Tools and MSBuild Tasks within the SDK that invoke binaries via the `dotnet` host are expected to honor this environment variable to ensure a consistent experience.

Tools that invoke `dotnet` during an SDK command should use the following algorithm to locate it:

* if `DOTNET_HOST_PATH` is set, use that value directly
* otherwise, rely on `dotnet` via the system's `PATH`

> [!NOTE]
> `DOTNET_HOST_PATH` is not a general solution for locating the `dotnet` host. It is only intended to be used by tools that are invoked by the .NET SDK.

### `NUGET_PACKAGES`

The global packages folder. If not set, it defaults to `~/.nuget/packages` on Unix or `%userprofile%\.nuget\packages` on Windows.
Expand Down