Skip to content

Commit

Permalink
Merge branch 'release/8.0.1xx' into release/8.0.2xx
Browse files Browse the repository at this point in the history
  • Loading branch information
v-codyguan committed Nov 15, 2023
2 parents a1c5ff7 + 91840a4 commit 7d995fc
Show file tree
Hide file tree
Showing 64 changed files with 835 additions and 195 deletions.
2 changes: 1 addition & 1 deletion documentation/manpages/sdk/dotnet-add-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-add-package" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-add-package" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet add package
.PP
Expand Down
16 changes: 15 additions & 1 deletion documentation/manpages/sdk/dotnet-add-reference.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-add-reference" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-add-reference" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet add reference
.PP
Expand Down Expand Up @@ -46,6 +46,20 @@ After running the command, the \f[V]<ProjectReference>\f[R] elements are added t
</ItemGroup>
\f[R]
.fi
.SS Add a reference to an assembly that isn\[cq]t in a project
.PP
There\[cq]s no CLI command to add a reference to an assembly that isn\[cq]t in a project or a package.
But you can do that by editing your \f[I].csproj\f[R] file and adding markup similar to the following example:
.IP
.nf
\f[C]
<ItemGroup>
<Reference Include=\[dq]MyAssembly\[dq]>
<HintPath>\[dq].\[rs]MyDLLFolder\[rs]MyAssembly.dll</HintPath>
</Reference>
</ItemGroup>
\f[R]
.fi
.SH ARGUMENTS
.IP \[bu] 2
\f[B]\f[VB]PROJECT\f[B]\f[R]
Expand Down
2 changes: 1 addition & 1 deletion documentation/manpages/sdk/dotnet-build-server.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-build-server" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-build-server" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet build-server
.PP
Expand Down
75 changes: 70 additions & 5 deletions documentation/manpages/sdk/dotnet-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-build" "1" "2022-10-21" "" ".NET Documentation"
.TH "dotnet-build" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet build
.PP
Expand All @@ -28,10 +28,14 @@ dotnet-build - Builds a project and all of its dependencies.
\f[C]
dotnet build [<PROJECT>|<SOLUTION>] [-a|--arch <ARCHITECTURE>]
[-c|--configuration <CONFIGURATION>] [-f|--framework <FRAMEWORK>]
[--disable-build-servers]
[--force] [--interactive] [--no-dependencies] [--no-incremental]
[--no-restore] [--nologo] [--no-self-contained] [--os <OS>]
[-o|--output <OUTPUT_DIRECTORY>] [-r|--runtime <RUNTIME_IDENTIFIER>]
[--self-contained [true|false]] [--source <SOURCE>] [--use-current-runtime, --ucr [true|false]]
[-o|--output <OUTPUT_DIRECTORY>]
[-p|--property:<PROPERTYNAME>=<VALUE>]
[-r|--runtime <RUNTIME_IDENTIFIER>]
[--self-contained [true|false]] [--source <SOURCE>]
[--tl [auto|on|off]] [--use-current-runtime, --ucr [true|false]]
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]

dotnet build -h|--help
Expand Down Expand Up @@ -135,6 +139,15 @@ Defines the build configuration.
The default for most projects is \f[V]Debug\f[R], but you can override the build configuration settings in your project.
.RE
.IP \[bu] 2
\f[B]\f[VB]--disable-build-servers\f[B]\f[R]
.RS 2
.PP
Forces the command to ignore any persistent build servers.
This option provides a consistent way to disable all use of build caching, which forces a build from scratch.
A build that doesn\[cq]t rely on caches is useful when the caches might be corrupted or incorrect for some reason.
Available since .NET 7 SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]-f|--framework <FRAMEWORK>\f[B]\f[R]
.RS 2
.PP
Expand Down Expand Up @@ -203,6 +216,14 @@ Available since .NET 6 SDK.
Directory in which to place the built binaries.
If not specified, the default path is \f[V]./bin/<configuration>/<framework>/\f[R].
For projects with multiple target frameworks (via the \f[V]TargetFrameworks\f[R] property), you also need to define \f[V]--framework\f[R] when you specify this option.
.IP \[bu] 2
\&.NET 7.0.200 SDK and later
.RS 2
.PP
If you specify the \f[V]--output\f[R] option when running this command on a solution, the CLI will emit a warning (an error in 7.0.200) due to the unclear semantics of the output path.
The \f[V]--output\f[R] option is disallowed because all outputs of all built projects would be copied into the specified directory, which isn\[cq]t compatible with multi-targeted projects, as well as projects that have different versions of direct and transitive dependencies.
For more information, see Solution-level \f[V]--output\f[R] option no longer valid for build-related commands.
.RE
.RE
.IP \[bu] 2
\f[B]\f[VB]--os <OS>\f[B]\f[R]
Expand All @@ -215,6 +236,20 @@ If you use this option, don\[cq]t use the \f[V]-r|--runtime\f[R] option.
Available since .NET 6.
.RE
.IP \[bu] 2
\f[B]\f[VB]-p|--property:<PROPERTYNAME>=<VALUE>\f[B]\f[R]
.RS 2
.PP
Sets one or more MSBuild properties.
Specify multiple properties delimited by semicolons or by repeating the option:
.IP
.nf
\f[C]
--property:<NAME1>=<VALUE1>;<NAME2>=<VALUE2>
--property:<NAME1>=<VALUE1> --property:<NAME2>=<VALUE2>
\f[R]
.fi
.RE
.IP \[bu] 2
\f[B]\f[VB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
.RS 2
.PP
Expand All @@ -229,7 +264,7 @@ If not specified, the default is to build for the current OS and architecture.
.PP
Publishes the .NET runtime with the application so the runtime doesn\[cq]t need to be installed on the target machine.
The default is \f[V]true\f[R] if a runtime identifier is specified.
Available since .NET 6 SDK.
Available since .NET 6.
.RE
.IP \[bu] 2
\f[B]\f[VB]--source <SOURCE>\f[B]\f[R]
Expand All @@ -238,13 +273,43 @@ Available since .NET 6 SDK.
The URI of the NuGet package source to use during the restore operation.
.RE
.IP \[bu] 2
\f[B]\f[VB]--tl [auto|on|off]\f[B]\f[R]
.RS 2
.PP
Specifies whether the \f[I]terminal logger\f[R] should be used for the build output.
The default is \f[V]auto\f[R], which first verifies the environment before enabling terminal logging.
The environment check verifies that the terminal is capable of using modern output features and isn\[cq]t using a redirected standard output before enabling the new logger.
\f[V]on\f[R] skips the environment check and enables terminal logging.
\f[V]off\f[R] skips the environment check and uses the default console logger.
.PP
The terminal logger shows you the restore phase followed by the build phase.
During each phase, the currently building projects appear at the bottom of the terminal.
Each project that\[cq]s building outputs both the MSBuild target currently being built and the amount of time spent on that target.
You can search this information to learn more about the build.
When a project is finished building, a single \[lq]build completed\[rq] section is written for that captures:
.IP \[bu] 2
The name of the built project
.IP \[bu] 2
The target framework (if multi-targeted)
.IP \[bu] 2
The status of that build
.IP \[bu] 2
The primary output of that build (which is hyperlinked)
.IP \[bu] 2
Any diagnostics generated for that project
.PP
This option is available starting in .NET 8.
.RE
.IP \[bu] 2
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
.RS 2
.PP
Sets the verbosity level of the command.
Allowed values are \f[V]q[uiet]\f[R], \f[V]m[inimal]\f[R], \f[V]n[ormal]\f[R], \f[V]d[etailed]\f[R], and \f[V]diag[nostic]\f[R].
The default is \f[V]minimal\f[R].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
By default, MSBuild displays warnings and errors at all verbosity levels.
To exclude warnings, use \f[V]/property:WarningLevel=0\f[R].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity> and WarningLevel.
.RE
.IP \[bu] 2
\f[B]\f[VB]--use-current-runtime, --ucr [true|false]\f[B]\f[R]
Expand Down
10 changes: 9 additions & 1 deletion documentation/manpages/sdk/dotnet-clean.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-clean" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-clean" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet clean
.PP
Expand Down Expand Up @@ -89,6 +89,14 @@ Doesn\[cq]t display the startup banner or the copyright message.
.PP
The directory that contains the build artifacts to clean.
Specify the \f[V]-f|--framework <FRAMEWORK>\f[R] switch with the output directory switch if you specified the framework when the project was built.
.IP \[bu] 2
\&.NET 7.0.200 SDK and later
.RS 2
.PP
If you specify the \f[V]--output\f[R] option when running this command on a solution, the CLI will emit a warning (an error in 7.0.200) due to the unclear semantics of the output path.
The \f[V]--output\f[R] option is disallowed because all outputs of all built projects would be copied into the specified directory, which isn\[cq]t compatible with multi-targeted projects, as well as projects that have different versions of direct and transitive dependencies.
For more information, see Solution-level \f[V]--output\f[R] option no longer valid for build-related commands.
.RE
.RE
.IP \[bu] 2
\f[B]\f[VB]-r|--runtime <RUNTIME_IDENTIFIER>\f[B]\f[R]
Expand Down
4 changes: 3 additions & 1 deletion documentation/manpages/sdk/dotnet-dev-certs.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-dev-certs" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-dev-certs" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet dev-certs
.PP
Expand Down Expand Up @@ -171,8 +171,10 @@ The file format is independent of the file name extension.
For example, if you specify \f[V]--format pfx\f[R] and \f[V]--export-path ./cert.pem\f[R], you\[cq]ll get a file named \f[I]cert.pem\f[R] in \f[V]PFX\f[R] format.
.PP
For information about the effect of this option when used with \f[V]--password\f[R], \f[V]--no-password\f[R], or without either of those options, see \[en]export-path earlier in this article.
.RE
.IP \[bu] 2
\f[B]\f[VB]-i|--import <PATH>\f[B]\f[R]
.RS 2
.PP
Imports the provided HTTPS development certificate into the local machine.
Requires that you also specify the \f[V]--clean\f[R] option, which clears out any existing HTTPS developer certificates.
Expand Down
44 changes: 39 additions & 5 deletions documentation/manpages/sdk/dotnet-environment-variables.7
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-environment-variables" "7" "2022-09-19" "" ".NET Documentation"
.TH "dotnet-environment-variables" "7" "2023-10-25" "" ".NET Documentation"
.hy
.SH NAME
.PP
Expand All @@ -23,9 +23,9 @@ dotnet-environment-variables - .NET environment variables
.PP
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
.PP
In this article, you\[cq]ll learn about the environment variables used by .NET SDK, .NET CLI, and .NET runtime.
In this article, you\[cq]ll learn about the environment variables used by .NET.
Some environment variables are used by the .NET runtime, while others are only used by the .NET SDK and .NET CLI.
Some environment variables are used by all.
Some environment variables are used by all three components.
.SS .NET runtime environment variables
.SS \f[V]DOTNET_SYSTEM_NET_HTTP_*\f[R]
.PP
Expand Down Expand Up @@ -257,9 +257,35 @@ By default trace information is accumulated in a circular buffer and the content
.PP
Specifies the location of the .NET runtimes, if they are not installed in the default location.
The default location on Windows is \f[V]C:\[rs]Program Files\[rs]dotnet\f[R].
The default location on Linux and macOS is \f[V]/usr/local/share/dotnet\f[R].
The default location on macOS is \f[V]/usr/local/share/dotnet\f[R].
The default location on Linux varies depending on distro and installment method.
The default location on Ubuntu 22.04 is \f[V]/usr/share/dotnet\f[R] (when installed from \f[V]packages.microsoft.com\f[R]) or \f[V]/usr/lib/dotnet\f[R] (when installed from Jammy feed).
For more information, see the following resources:
.IP \[bu] 2
Troubleshoot app launch failures
.IP \[bu] 2
GitHub issue dotnet/core#7699 (https://github.com/dotnet/core/issues/7699)
.IP \[bu] 2
GitHub issue dotnet/runtime#79237 (https://github.com/dotnet/runtime/issues/79237)
.PP
This environment variable is used only when running apps via generated executables (apphosts).
\f[V]DOTNET_ROOT(x86)\f[R] is used instead when running a 32-bit executable on a 64-bit OS.
.SS \f[V]DOTNET_HOST_PATH\f[R]
.PP
Specifies the absolute path to a \f[V]dotnet\f[R] host (\f[V]dotnet.exe\f[R] on Windows, \f[V]dotnet\f[R] on Linux and macOS) that was used to launch the currently-running \f[V]dotnet\f[R] process.
This is used by the .NET SDK to help tools that run during .NET SDK commands ensure they use the same \f[V]dotnet\f[R] runtime for any child \f[V]dotnet\f[R] processes they create for the duration of the command.
Tools and MSBuild Tasks within the SDK that invoke binaries via the \f[V]dotnet\f[R] host are expected to honor this environment variable to ensure a consistent experience.
.PP
Tools that invoke \f[V]dotnet\f[R] during an SDK command should use the following algorithm to locate it:
.IP \[bu] 2
if \f[V]DOTNET_HOST_PATH\f[R] is set, use that value directly
.IP \[bu] 2
otherwise, rely on \f[V]dotnet\f[R] via the system\[cq]s \f[V]PATH\f[R]
.RS
.PP
\f[V]DOTNET_HOST_PATH\f[R] is not a general solution for locating the \f[V]dotnet\f[R] host.
It is only intended to be used by tools that are invoked by the .NET SDK.
.RE
.SS \f[V]NUGET_PACKAGES\f[R]
.PP
The global packages folder.
Expand Down Expand Up @@ -323,6 +349,10 @@ For more information, see the \f[V]--roll-forward\f[R] option for the \f[V]dotne
Disables minor version roll forward, if set to \f[V]0\f[R].
This setting is superseded in .NET Core 3.0 by \f[V]DOTNET_ROLL_FORWARD\f[R].
The new settings should be used instead.
.SS \f[V]DOTNET_CLI_FORCE_UTF8_ENCODING\f[R]
.PP
Forces the use of UTF-8 encoding in the console, even for older versions of Windows 10 that don\[cq]t fully support UTF-8.
For more information, see SDK no longer changes console encoding when finished.
.SS \f[V]DOTNET_CLI_UI_LANGUAGE\f[R]
.PP
Sets the language of the CLI UI using a locale value such as \f[V]en-us\f[R].
Expand Down Expand Up @@ -366,8 +396,12 @@ For more information, see Advertising manifests.
.SS \f[V]DOTNET_CLI_WORKLOAD_UPDATE_NOTIFY_INTERVAL_HOURS\f[R]
.PP
Specifies the minimum number of hours between background downloads of advertising manifests for workloads.
Default is \f[V]24\f[R] - no more frequently than once a day.
The default is \f[V]24\f[R], which is no more frequently than once a day.
For more information, see Advertising manifests.
.SS \f[V]DOTNET_TOOLS_ALLOW_MANIFEST_IN_ROOT\f[R]
.PP
Specifies whether .NET SDK local tools search for tool manifest files in the root folder on Windows.
The default is \f[V]false\f[R].
.SS \f[V]COREHOST_TRACE\f[R]
.PP
Controls diagnostics tracing from the hosting components, such as \f[V]dotnet.exe\f[R], \f[V]hostfxr\f[R], and \f[V]hostpolicy\f[R].
Expand Down
2 changes: 1 addition & 1 deletion documentation/manpages/sdk/dotnet-format.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-format" "1" "2022-06-20" "" ".NET Documentation"
.TH "dotnet-format" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet format
.PP
Expand Down
2 changes: 1 addition & 1 deletion documentation/manpages/sdk/dotnet-help.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-help" "1" "2022-10-10" "" ".NET Documentation"
.TH "dotnet-help" "1" "2023-10-25" "" ".NET Documentation"
.hy
.SH dotnet help reference
.PP
Expand Down
Loading

0 comments on commit 7d995fc

Please sign in to comment.