Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
60 changes: 25 additions & 35 deletions documentation/manpages/sdk/dotnet-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-build" "1" "2025-09-30" "" ".NET Documentation"
.TH "dotnet-build" "1" "2025-10-15" "" ".NET Documentation"
.hy
.SH dotnet build
.PP
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 and later versions
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 SDK and later versions
.SH NAME
.PP
dotnet-build - Builds a project, solution, or file-based app and all of its dependencies.
Expand All @@ -28,15 +28,13 @@ dotnet-build - Builds a project, solution, or file-based app and all of its depe
\f[C]
dotnet build [<PROJECT>|<SOLUTION>|<FILE>] [-a|--arch <ARCHITECTURE>]
[--artifacts-path <ARTIFACTS_DIR>]
[-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>]
[-p|--property:<PROPERTYNAME>=<VALUE>]
[-r|--runtime <RUNTIME_IDENTIFIER>]
[-sc|--self-contained [true|false]] [--source <SOURCE>]
[--tl:[auto|on|off]] [--use-current-runtime, --ucr [true|false]]
[-c|--configuration <CONFIGURATION>] [--disable-build-servers]
[-f|--framework <FRAMEWORK>] [--force] [--interactive]
[--no-dependencies] [--no-incremental] [--no-restore] [--nologo]
[--no-self-contained] [-o|--output <OUTPUT_DIRECTORY>] [--os <OS>]
[-p|--property:<PROPERTYNAME>=<VALUE>] [-r|--runtime <RUNTIME_IDENTIFIER>]
[--sc|--self-contained] [--source <SOURCE>]
[--tl:[auto|on|off]] [ --ucr|--use-current-runtime]
[-v|--verbosity <LEVEL>] [--version-suffix <VERSION_SUFFIX>]

dotnet build -h|--help
Expand Down Expand Up @@ -176,12 +174,6 @@ Forces all dependencies to be resolved even if the last restore was successful.
Specifying this flag is the same as deleting the \f[I]project.assets.json\f[R] file.
.RE
.IP \[bu] 2
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Prints out a description of how to use the command.
.RE
.IP \[bu] 2
\f[B]\f[VB]--interactive\f[B]\f[R]
.RS 2
.PP
Expand Down Expand Up @@ -218,9 +210,7 @@ Doesn\[cq]t display the startup banner or the copyright message.
\f[B]\f[VB]--no-self-contained\f[B]\f[R]
.RS 2
.PP
Publishes the application as a framework dependent application.
A compatible .NET runtime must be installed on the target machine to run the application.
Available since .NET 6 SDK.
Equivalent to \f[V]--self-contained false\f[R].
.RE
.IP \[bu] 2
\f[B]\f[VB]-o|--output <OUTPUT_DIRECTORY>\f[B]\f[R]
Expand Down Expand Up @@ -272,12 +262,11 @@ If you use this option with .NET 6 SDK, use \f[V]--self-contained\f[R] or \f[V]-
If not specified, the default is to build for the current OS and architecture.
.RE
.IP \[bu] 2
\f[B]\f[VB]--self-contained [true|false]\f[B]\f[R]
\f[B]\f[VB]--sc|--self-contained\f[B]\f[R]
.RS 2
.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.
Publish the .NET runtime with your application so the runtime doesn\[cq]t need to be installed on the target machine.
The default is \f[V]true\f[R].
.RE
.IP \[bu] 2
\f[B]\f[VB]--source <SOURCE>\f[B]\f[R]
Expand Down Expand Up @@ -314,23 +303,18 @@ Any diagnostics generated for that project.
This option is available starting in .NET 8.
.RE
.IP \[bu] 2
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
\f[B]\f[VB]--ucr|--use-current-runtime\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].
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.
Use the current runtime as the target runtime.
.RE
.IP \[bu] 2
\f[B]\f[VB]--use-current-runtime, --ucr [true|false]\f[B]\f[R]
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
.RS 2
.PP
Sets the \f[V]RuntimeIdentifier\f[R] to a platform portable \f[V]RuntimeIdentifier\f[R] based on the one of your machine.
This happens implicitly with properties that require a \f[V]RuntimeIdentifier\f[R], such as \f[V]SelfContained\f[R], \f[V]PublishAot\f[R], \f[V]PublishSelfContained\f[R], \f[V]PublishSingleFile\f[R], and \f[V]PublishReadyToRun\f[R].
If the property is set to false, that implicit resolution will no longer occur.
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].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
.RE
.IP \[bu] 2
\f[B]\f[VB]--version-suffix <VERSION_SUFFIX>\f[B]\f[R]
Expand All @@ -340,6 +324,12 @@ Sets the value of the \f[V]$(VersionSuffix)\f[R] property to use when building t
This only works if the \f[V]$(Version)\f[R] property isn\[cq]t set.
Then, \f[V]$(Version)\f[R] is set to the \f[V]$(VersionPrefix)\f[R] combined with the \f[V]$(VersionSuffix)\f[R], separated by a dash.
.RE
.IP \[bu] 2
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Prints out a description of how to use the command.
.RE
.SH EXAMPLES
.IP \[bu] 2
Build a project and its dependencies:
Expand Down
4 changes: 2 additions & 2 deletions documentation/manpages/sdk/dotnet-clean.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-clean" "1" "2025-09-30" "" ".NET Documentation"
.TH "dotnet-clean" "1" "2025-10-15" "" ".NET Documentation"
.hy
.SH dotnet clean
.PP
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 and later versions
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 SDK and later versions
.SH NAME
.PP
dotnet-clean - Cleans the output of a project.
Expand Down
13 changes: 10 additions & 3 deletions documentation/manpages/sdk/dotnet-dev-certs.1
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-dev-certs" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-dev-certs" "1" "2025-10-15" "" ".NET Documentation"
.hy
.SH dotnet dev-certs
.PP
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 3.1 SDK and later versions
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 SDK and later versions
.SH NAME
.PP
dotnet-dev-certs - Generates a self-signed certificate to enable HTTPS use in development.
Expand All @@ -28,7 +28,8 @@ dotnet-dev-certs - Generates a self-signed certificate to enable HTTPS use in de
.nf
\f[C]
dotnet dev-certs https
[-c|--check] [--clean] [-ep|--export-path <PATH>]
[-c|--check] [--check-trust-machine-readable]
[--clean] [-ep|--export-path <PATH>]
[--format] [-i|--import] [-np|--no-password]
[-p|--password] [-q|--quiet] [-t|--trust]
[-v|--verbose] [--version]
Expand Down Expand Up @@ -91,6 +92,12 @@ Checks for the existence of the development certificate but doesn\[cq]t perform
Use this option with the \f[V]--trust\f[R] option to check if the certificate is not only valid but also trusted.
.RE
.IP \[bu] 2
\f[B]\f[VB]--check-trust-machine-readable\f[B]\f[R]
.RS 2
.PP
Same as running \f[V]--check --trust\f[R], but outputs the results in JSON.
.RE
.IP \[bu] 2
\f[B]\f[VB]--clean\f[B]\f[R]
.RS 2
.PP
Expand Down
36 changes: 1 addition & 35 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" "2025-07-30" "" ".NET Documentation"
.TH "dotnet-environment-variables" "7" "2025-10-15" "" ".NET Documentation"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -178,40 +178,6 @@ To opt-out, set the value to either \f[V]false\f[R] or \f[V]0\f[R].
.PP
Starting in .NET 5, this setting to use <xref:System.Net.Http.HttpClientHandler> is no longer available.
.RE
.SS \f[V]DOTNET_Jit*\f[R] and \f[V]DOTNET_GC*\f[R]
.PP
There are two stressing-related features for the JIT and JIT-generated GC information: JIT Stress and GC Hole Stress.
These features provide a way during development to discover edge cases and more \[lq]real world\[rq] scenarios without having to develop complex applications.
The following environment variables are available:
.IP \[bu] 2
\f[V]DOTNET_JitStress\f[R]
.IP \[bu] 2
\f[V]DOTNET_JitStressModeNamesOnly\f[R]
.IP \[bu] 2
\f[V]DOTNET_GCStress\f[R]
.SS JIT stress
.PP
Enabling JIT Stress can be done in several ways.
Set \f[V]DOTNET_JitStress\f[R] to a non-zero integer value to generate varying levels of JIT optimizations based on a hash of the method\[cq]s name.
To apply all optimizations set \f[V]DOTNET_JitStress=2\f[R], for example.
Another way to enable JIT Stress is by setting \f[V]DOTNET_JitStressModeNamesOnly=1\f[R] and then requesting the stress modes, space-delimited, in the \f[V]DOTNET_JitStressModeNames\f[R] variable.
.PP
As an example, consider:
.IP
.nf
\f[C]
DOTNET_JitStressModeNames=STRESS_USE_CMOV STRESS_64RSLT_MUL STRESS_LCL_FLDS
\f[R]
.fi
.SS GC Hole stress
.PP
Enabling GC Hole Stress causes GCs to always occur in specific locations and that helps to track down GC holes.
GC Hole Stress can be enabled using the \f[V]DOTNET_GCStress\f[R] environment variable.
.PP
For more information, see Investigating JIT and GC Hole stress (https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/jit/investigate-stress.md).
.SS JIT memory barriers
.PP
The code generator for Arm64 allows all \f[V]MemoryBarriers\f[R] instructions to be removed by setting \f[V]DOTNET_JitNoMemoryBarriers\f[R] to \f[V]1\f[R].
.SS \f[V]DOTNET_RUNNING_IN_CONTAINER\f[R] and \f[V]DOTNET_RUNNING_IN_CONTAINERS\f[R]
.PP
The official .NET images (Windows and Linux) set the well-known environment variables:
Expand Down
85 changes: 52 additions & 33 deletions documentation/manpages/sdk/dotnet-format.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,24 @@
. ftr VB CB
. ftr VBI CBI
.\}
.TH "dotnet-format" "1" "2025-06-13" "" ".NET Documentation"
.TH "dotnet-format" "1" "2025-10-15" "" ".NET Documentation"
.hy
.SH dotnet format
.PP
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6.x SDK and later versions
\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 SDK and later versions
.SH NAME
.PP
dotnet-format - Formats code to match \f[V]editorconfig\f[R] settings.
.SH SYNOPSIS
.IP
.nf
\f[C]
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format [<PROJECT | SOLUTION>]
[--binarylog <BINARY-LOG-PATH>] [--diagnostics <DIAGNOSTICS>]
[--exclude <EXCLUDE>] [--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>]
[--include <INCLUDE>] [--include-generated]
[--no-restore] [--report <REPORT-PATH>] [--severity <LEVEL>]
[-v|--verbosity <LEVEL>] [--verify-no-changes] [--version]

dotnet format -h|--help
\f[R]
Expand All @@ -46,6 +51,12 @@ If a project or solution file is not specified, MSBuild searches the current wor
.PP
None of the options below are required for the \f[V]dotnet format\f[R] command to succeed, but you can use them to further customize what is formatted and by which rules.
.IP \[bu] 2
\f[B]\f[VB]--binarylog <BINARY-LOG-PATH>\f[B]\f[R]
.RS 2
.PP
Logs all project or solution load information to a binary log file.
.RE
.IP \[bu] 2
\f[B]\f[VB]--diagnostics <DIAGNOSTICS>\f[B]\f[R]
.RS 2
.PP
Expand All @@ -54,72 +65,80 @@ Default value is whichever IDs are listed in the \f[I].editorconfig\f[R] file.
For a list of built-in analyzer rule IDs that you can specify, see the list of IDs for code-analysis style rules.
.RE
.IP \[bu] 2
\f[B]\f[VB]--severity\f[B]\f[R]
\f[B]\f[VB]--exclude <EXCLUDE>\f[B]\f[R]
.RS 2
.PP
The minimum severity of diagnostics to fix.
Allowed values are \f[V]info\f[R], \f[V]warn\f[R], and \f[V]error\f[R].
The default value is \f[V]warn\f[R].
A space-separated list of relative file or folder paths to exclude from formatting.
The default is none.
.RE
.IP \[bu] 2
\f[B]\f[VB]--no-restore\f[B]\f[R]
\f[B]\f[VB]--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>\f[B]\f[R]
.RS 2
.PP
Doesn\[cq]t execute an implicit restore before formatting.
Default is to do implicit restore.
A space-separated list of diagnostic IDs to exclude when fixing code style or third-party issues.
Default value is none.
For a list of built-in analyzer rule IDs that you can specify, see the list of IDs for code-analysis style rules.
.RE
.IP \[bu] 2
\f[B]\f[VB]--verify-no-changes\f[B]\f[R]
\f[B]\f[VB]--include <INCLUDE>\f[B]\f[R]
.RS 2
.PP
Verifies that no formatting changes would be performed.
Terminates with a non zero exit code if any files would have been formatted.
A space-separated list of relative file or folder paths to include in formatting.
The default is all files in the solution or project.
.RE
.IP \[bu] 2
\f[B]\f[VB]--include <INCLUDE>\f[B]\f[R]
\f[B]\f[VB]--include-generated\f[B]\f[R]
.RS 2
.PP
A space-separated list of relative file or folder paths to include in formatting.
The default is all files in the solution or project.
Formats files generated by the SDK.
.RE
.IP \[bu] 2
\f[B]\f[VB]--exclude <EXCLUDE>\f[B]\f[R]
\f[B]\f[VB]--no-restore\f[B]\f[R]
.RS 2
.PP
A space-separated list of relative file or folder paths to exclude from formatting.
The default is none.
Doesn\[cq]t execute an implicit restore before formatting.
Default is to do implicit restore.
.RE
.IP \[bu] 2
\f[B]\f[VB]--include-generated\f[B]\f[R]
\f[B]\f[VB]--report <REPORT-PATH>\f[B]\f[R]
.RS 2
.PP
Formats files generated by the SDK.
Produces a JSON report in the directory specified by \f[V]<REPORT_PATH>\f[R].
.RE
.IP \[bu] 2
\f[B]\f[VB]-v|--verbosity <LEVEL>\f[B]\f[R]
\f[B]\f[VB]--severity <LEVEL>\f[B]\f[R]
.RS 2
.PP
Sets the verbosity level.
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].
Default value is \f[V]m[inimal]\f[R].
The minimum severity of diagnostics to fix.
Allowed values are \f[V]info\f[R], \f[V]warn\f[R], and \f[V]error\f[R].
The default value is \f[V]warn\f[R].
.RE
.IP \[bu] 2
\f[B]\f[VB]--binarylog <BINARY-LOG-PATH>\f[B]\f[R]
\f[B]\f[VB]--verify-no-changes\f[B]\f[R]
.RS 2
.PP
Logs all project or solution load information to a binary log file.
Verifies that no formatting changes would be performed.
Terminates with a non zero exit code if any files would have been formatted.
.RE
.IP \[bu] 2
\f[B]\f[VB]--report <REPORT-PATH>\f[B]\f[R]
\f[B]\f[VB]--version\f[B]\f[R]
.RS 2
.PP
Produces a JSON report in the directory specified by \f[V]<REPORT_PATH>\f[R].
Displays version information.
.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].
For more information, see <xref:Microsoft.Build.Framework.LoggerVerbosity>.
.RE
.IP \[bu] 2
\f[B]\f[VB]-h|--help\f[B]\f[R]
\f[B]\f[VB]-?|-h|--help\f[B]\f[R]
.RS 2
.PP
Shows help and usage information
Prints out a description of how to use the command.
.RE
.SS Subcommands
.SS Whitespace
Expand Down Expand Up @@ -153,7 +172,7 @@ Default value is whichever IDs are listed in the \f[I].editorconfig\f[R] file.
For a list of built-in code style analyzer rule IDs that you can specify, see the list of IDs for code-analysis style rules.
.RE
.IP \[bu] 2
\f[B]\f[VB]--severity\f[B]\f[R]
\f[B]\f[VB]--severity <LEVEL>\f[B]\f[R]
.RS 2
.PP
The minimum severity of diagnostics to fix.
Expand All @@ -178,7 +197,7 @@ For a list of built-in analyzer rule IDs that you can specify, see the list of I
For third-party analyzers refer to their documentation.
.RE
.IP \[bu] 2
\f[B]\f[VB]--severity\f[B]\f[R]
\f[B]\f[VB]--severity <LEVEL>\f[B]\f[R]
.RS 2
.PP
The minimum severity of diagnostics to fix.
Expand Down
Loading