diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index d772f896381f..3fe0b198957f 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,3 +1,7 @@ +Use the instructions from the main branch if available: @dotnet/sdk/files/.github/copilot-instructions.md + +If the instructions from main are not available, use the following as a fallback: + Coding Style and Changes: - Code should match the style of the file it's in. - Changes should be minimal to resolve a problem in a clean way. diff --git a/build/RunTestsOnHelix.cmd b/build/RunTestsOnHelix.cmd index f55fcf1ead42..3dc68bb7f8af 100644 --- a/build/RunTestsOnHelix.cmd +++ b/build/RunTestsOnHelix.cmd @@ -10,6 +10,9 @@ set PATH=%DOTNET_ROOT%;%PATH% set DOTNET_MULTILEVEL_LOOKUP=0 set TestFullMSBuild=%1 +REM Ensure Visual Studio instances allow preview SDKs +PowerShell -ExecutionPolicy ByPass -NoProfile -File "%HELIX_CORRELATION_PAYLOAD%\t\eng\enable-preview-sdks.ps1" + REM Use powershell to call partical Arcade logic to get full framework msbuild path and assign it if "%TestFullMSBuild%"=="true" ( FOR /F "tokens=*" %%g IN ('PowerShell -ExecutionPolicy ByPass -File "%HELIX_CORRELATION_PAYLOAD%\t\eng\print-full-msbuild-path.ps1"') do (SET DOTNET_SDK_TEST_MSBUILD_PATH=%%g) diff --git a/documentation/general/dotnet-run-file.md b/documentation/general/dotnet-run-file.md index a14132092ee1..77ea47410b0f 100644 --- a/documentation/general/dotnet-run-file.md +++ b/documentation/general/dotnet-run-file.md @@ -248,6 +248,16 @@ The directives are processed as follows: (because `ProjectReference` items don't support directory paths). An error is reported if zero or more than one projects are found in the directory, just like `dotnet reference add` would do. +Directive values support MSBuild variables (like `$(..)`) normally as they are translated literally and left to MSBuild engine to process. +However, in `#:project` directives, variables might not be preserved during [grow up](#grow-up), +because there is additional processing of those directives that makes it technically challenging to preserve variables in all cases +(project directive values need to be resolved to be relative to the target directory +and also to point to a project file rather than a directory). +Note that it is not expected that variables inside the path change their meaning during the conversion, +so for example `#:project ../$(LibName)` is translated to `` (i.e., the variable is preserved). +However, variables at the start can change, so for example `#:project $(ProjectDir)../Lib` is translated to `` (i.e., the variable is expanded). +In other directives, all variables are preserved during conversion. + Because these directives are limited by the C# language to only appear before the first "C# token" and any `#if`, dotnet CLI can look for them via a regex or Roslyn lexer without any knowledge of defined conditional symbols and can do that efficiently by stopping the search when it sees the first "C# token". diff --git a/documentation/manpages/sdk/dotnet-build-server.1 b/documentation/manpages/sdk/dotnet-build-server.1 index 98776e91f204..7e4bb67eb449 100644 --- a/documentation/manpages/sdk/dotnet-build-server.1 +++ b/documentation/manpages/sdk/dotnet-build-server.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-build-server" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-build-server" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet build-server .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-build-server - Interacts with servers started by a build. diff --git a/documentation/manpages/sdk/dotnet-build.1 b/documentation/manpages/sdk/dotnet-build.1 index fb7ce5950153..cb9d668228ec 100644 --- a/documentation/manpages/sdk/dotnet-build.1 +++ b/documentation/manpages/sdk/dotnet-build.1 @@ -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-30" "" ".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. @@ -28,15 +28,13 @@ dotnet-build - Builds a project, solution, or file-based app and all of its depe \f[C] dotnet build [||] [-a|--arch ] [--artifacts-path ] - [-c|--configuration ] [-f|--framework ] - [--disable-build-servers] - [--force] [--interactive] [--no-dependencies] [--no-incremental] - [--no-restore] [--nologo] [--no-self-contained] [--os ] - [-o|--output ] - [-p|--property:=] - [-r|--runtime ] - [-sc|--self-contained [true|false]] [--source ] - [--tl:[auto|on|off]] [--use-current-runtime, --ucr [true|false]] + [-c|--configuration ] [--disable-build-servers] + [-f|--framework ] [--force] [--interactive] + [--no-dependencies] [--no-incremental] [--no-restore] [--nologo] + [--no-self-contained] [-o|--output ] [--os ] + [-p|--property:=] [-r|--runtime ] + [--sc|--self-contained] [--source ] + [--tl:[auto|on|off]] [ --ucr|--use-current-runtime] [-v|--verbosity ] [--version-suffix ] dotnet build -h|--help @@ -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 @@ -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 \f[B]\f[R] @@ -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 \f[B]\f[R] @@ -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 \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 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 \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 . .RE .IP \[bu] 2 \f[B]\f[VB]--version-suffix \f[B]\f[R] @@ -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: diff --git a/documentation/manpages/sdk/dotnet-clean.1 b/documentation/manpages/sdk/dotnet-clean.1 index d59683069976..1b484daf6d26 100644 --- a/documentation/manpages/sdk/dotnet-clean.1 +++ b/documentation/manpages/sdk/dotnet-clean.1 @@ -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-30" "" ".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. diff --git a/documentation/manpages/sdk/dotnet-dev-certs.1 b/documentation/manpages/sdk/dotnet-dev-certs.1 index 35379f0069ef..e0c8362f5d1c 100644 --- a/documentation/manpages/sdk/dotnet-dev-certs.1 +++ b/documentation/manpages/sdk/dotnet-dev-certs.1 @@ -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-30" "" ".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. @@ -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 ] + [-c|--check] [--check-trust-machine-readable] + [--clean] [-ep|--export-path ] [--format] [-i|--import] [-np|--no-password] [-p|--password] [-q|--quiet] [-t|--trust] [-v|--verbose] [--version] @@ -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 diff --git a/documentation/manpages/sdk/dotnet-environment-variables.7 b/documentation/manpages/sdk/dotnet-environment-variables.7 index 15f048c32d13..501263aeb1f9 100644 --- a/documentation/manpages/sdk/dotnet-environment-variables.7 +++ b/documentation/manpages/sdk/dotnet-environment-variables.7 @@ -14,14 +14,14 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-environment-variables" "7" "2025-07-30" "" ".NET Documentation" +.TH "dotnet-environment-variables" "7" "2025-10-30" "" ".NET Documentation" .hy .SH NAME .PP dotnet-environment-variables - .NET environment variables .SH DESCRIPTION .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 .PP 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. @@ -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 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: @@ -457,11 +423,6 @@ If set to \f[V]1\f[R] (enabled), enables rolling forward to a pre-release versio By default (\f[V]0\f[R] - disabled), when a release version of .NET runtime is requested, roll-forward will only consider installed release versions. .PP For more information, see the \f[V]--roll-forward\f[R] option for the \f[V]dotnet\f[R] command. -.SS \f[V]DOTNET_ROLL_FORWARD_ON_NO_CANDIDATE_FX\f[R] -.PP -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. diff --git a/documentation/manpages/sdk/dotnet-format.1 b/documentation/manpages/sdk/dotnet-format.1 index b3d603d890c8..0ffac6af7de9 100644 --- a/documentation/manpages/sdk/dotnet-format.1 +++ b/documentation/manpages/sdk/dotnet-format.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-format" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-format" "1" "2025-10-30" "" ".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. @@ -26,7 +26,12 @@ dotnet-format - Formats code to match \f[V]editorconfig\f[R] settings. .IP .nf \f[C] -dotnet format [] [command] [options] +dotnet format [] + [--binarylog ] [--diagnostics ] + [--exclude ] [--exclude-diagnostics ] + [--include ] [--include-generated] + [--no-restore] [--report ] [--severity ] + [-v|--verbosity ] [--verify-no-changes] [--version] dotnet format -h|--help \f[R] @@ -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 \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 \f[B]\f[R] .RS 2 .PP @@ -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 \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 \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 \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 \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 \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 \f[B]\f[R] .RS 2 .PP -Formats files generated by the SDK. +Produces a JSON report in the directory specified by \f[V]\f[R]. .RE .IP \[bu] 2 -\f[B]\f[VB]-v|--verbosity \f[B]\f[R] +\f[B]\f[VB]--severity \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 \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 \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]\f[R]. +Displays version information. +.RE +.IP \[bu] 2 +\f[B]\f[VB]-v|--verbosity \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 . .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 @@ -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 \f[B]\f[R] .RS 2 .PP The minimum severity of diagnostics to fix. @@ -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 \f[B]\f[R] .RS 2 .PP The minimum severity of diagnostics to fix. diff --git a/documentation/manpages/sdk/dotnet-help.1 b/documentation/manpages/sdk/dotnet-help.1 index 6136b4a1f6a4..59677bea234e 100644 --- a/documentation/manpages/sdk/dotnet-help.1 +++ b/documentation/manpages/sdk/dotnet-help.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-help" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-help" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet help reference .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-help - Shows more detailed documentation online for the specified command. diff --git a/documentation/manpages/sdk/dotnet-migrate.1 b/documentation/manpages/sdk/dotnet-migrate.1 deleted file mode 100644 index 597a6275c919..000000000000 --- a/documentation/manpages/sdk/dotnet-migrate.1 +++ /dev/null @@ -1,130 +0,0 @@ -.\" Automatically generated by Pandoc 2.18 -.\" -.\" Define V font for inline verbatim, using C font in formats -.\" that render this, and otherwise B font. -.ie "\f[CB]x\f[]"x" \{\ -. ftr V B -. ftr VI BI -. ftr VB B -. ftr VBI BI -.\} -.el \{\ -. ftr V CR -. ftr VI CI -. ftr VB CB -. ftr VBI CBI -.\} -.TH "dotnet-migrate" "1" "2025-09-15" "" ".NET Documentation" -.hy -.SH dotnet migrate -.PP -\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 2.x SDK -.SH NAME -.PP -dotnet-migrate - Migrates a Preview 2 .NET Core project to a .NET Core SDK-style project. -.SH SYNOPSIS -.IP -.nf -\f[C] -dotnet migrate [] [--format-report-file-json ] - [-r|--report-file ] [-s|--skip-project-references [Debug|Release]] - [--skip-backup] [-t|--template-file ] [-v|--sdk-package-version] - [-x|--xproj-file] - -dotnet migrate -h|--help -\f[R] -.fi -.SH DESCRIPTION -.PP -This command is deprecated. -The \f[V]dotnet migrate\f[R] command is no longer available starting with .NET Core 3.0 SDK. -It can only migrate a Preview 2 .NET Core project to a 1.x .NET Core project, which is out of support. -.PP -By default, the command migrates the root project and any project references that the root project contains. -This behavior is disabled using the \f[V]--skip-project-references\f[R] option at run time. -.PP -Migration can be performed on the following assets: -.IP \[bu] 2 -A single project by specifying the \f[I]project.json\f[R] file to migrate. -.IP \[bu] 2 -All of the directories specified in the \f[I]global.json\f[R] file by passing in a path to the \f[I]global.json\f[R] file. -.IP \[bu] 2 -A \f[I]solution.sln\f[R] file, where it migrates the projects referenced in the solution. -.IP \[bu] 2 -On all subdirectories of the given directory recursively. -.PP -The \f[V]dotnet migrate\f[R] command keeps the migrated \f[I]project.json\f[R] file inside a \f[V]backup\f[R] directory, which it creates if the directory doesn\[cq]t exist. -This behavior is overridden using the \f[V]--skip-backup\f[R] option. -.PP -By default, the migration operation outputs the state of the migration process to standard output (STDOUT). -If you use the \f[V]--report-file \f[R] option, the output is saved to the file specify. -.PP -The \f[V]dotnet migrate\f[R] command only supports valid Preview 2 \f[I]project.json\f[R]-based projects. -This means that you cannot use it to migrate DNX or Preview 1 \f[I]project.json\f[R]-based projects directly to MSBuild/csproj projects. -You first need to manually migrate the project to a Preview 2 \f[I]project.json\f[R]-based project and then use the \f[V]dotnet migrate\f[R] command to migrate the project. -.SH ARGUMENTS -.PP -\f[V]PROJECT_JSON/GLOBAL_JSON/SOLUTION_FILE/PROJECT_DIR\f[R] -.PP -The path to one of the following: -.IP \[bu] 2 -a \f[I]project.json\f[R] file to migrate. -.IP \[bu] 2 -a \f[I]global.json\f[R] file: the folders specified in \f[I]global.json\f[R] are migrated. -.IP \[bu] 2 -a \f[I]solution.sln\f[R] file: the projects referenced in the solution are migrated. -.IP \[bu] 2 -a directory to migrate: recursively searches for \f[I]project.json\f[R] files to migrate inside the specified directory. -.PP -Defaults to current directory if nothing is specified. -.SH OPTIONS -.PP -\f[V]--format-report-file-json \f[R] -.PP -Output migration report file as JSON rather than user messages. -.PP -\f[V]-h|--help\f[R] -.PP -Prints out a short help for the command. -.PP -\f[V]-r|--report-file \f[R] -.PP -Output migration report to a file in addition to the console. -.PP -\f[V]-s|--skip-project-references [Debug|Release]\f[R] -.PP -Skip migrating project references. -By default, project references are migrated recursively. -.PP -\f[V]--skip-backup\f[R] -.PP -Skip moving \f[I]project.json\f[R], \f[I]global.json\f[R], and \f[I]*.xproj\f[R] to a \f[V]backup\f[R] directory after successful migration. -.PP -\f[V]-t|--template-file \f[R] -.PP -Template csproj file to use for migration. -By default, the same template as the one dropped by \f[V]dotnet new console\f[R] is used. -.PP -\f[V]-v|--sdk-package-version \f[R] -.PP -The version of the sdk package that\[cq]s referenced in the migrated app. -The default is the version of the SDK in \f[V]dotnet new\f[R]. -.PP -\f[V]-x|--xproj-file \f[R] -.PP -The path to the xproj file to use. -Required when there is more than one xproj in a project directory. -.SH EXAMPLES -.PP -Migrate a project in the current directory and all of its project-to-project dependencies: -.PP -\f[V]dotnet migrate\f[R] -.PP -Migrate all projects that \f[I]global.json\f[R] file includes: -.PP -\f[V]dotnet migrate path/to/global.json\f[R] -.PP -Migrate only the current project and no project-to-project (P2P) dependencies. -Also, use a specific SDK version: -.PP -\f[V]dotnet migrate -s -v 1.0.0-preview4\f[R] diff --git a/documentation/manpages/sdk/dotnet-msbuild.1 b/documentation/manpages/sdk/dotnet-msbuild.1 index bc37f2d92c52..7d9d02a6ec77 100644 --- a/documentation/manpages/sdk/dotnet-msbuild.1 +++ b/documentation/manpages/sdk/dotnet-msbuild.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-msbuild" "1" "2025-07-30" "" ".NET Documentation" +.TH "dotnet-msbuild" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet msbuild .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-msbuild - Builds a project and all of its dependencies. diff --git a/documentation/manpages/sdk/dotnet-new-install.1 b/documentation/manpages/sdk/dotnet-new-install.1 index 6a059e4c19e5..7bfe100df1d1 100644 --- a/documentation/manpages/sdk/dotnet-new-install.1 +++ b/documentation/manpages/sdk/dotnet-new-install.1 @@ -14,7 +14,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-install" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-new-install" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new install .PP @@ -69,6 +69,10 @@ Additionally, tab completion is now available for \f[V]dotnet new\f[R]. It supports completion for installed template names and for the options a selected template provides. To activate tab completion for the .NET SDK, see Enable tab completion. > > Examples of old syntax: > > - Install the latest version of Azure web jobs project template package: > > \f[V]dotnetcli > dotnet new --install Microsoft.Azure.WebJobs.ProjectTemplates >\f[R] +.RS +.PP +[!WARNING] Templates can run MSBuild code when triggered, don\[cq]t install or run untrusted .NET templates. +.RE .SH ARGUMENTS .IP \[bu] 2 \f[B]\f[VB]\f[B]\f[R] diff --git a/documentation/manpages/sdk/dotnet-new-list.1 b/documentation/manpages/sdk/dotnet-new-list.1 index 1b01e6440af1..35e47358f5cb 100644 --- a/documentation/manpages/sdk/dotnet-new-list.1 +++ b/documentation/manpages/sdk/dotnet-new-list.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-list" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-new-list" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new list .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-new-list - Lists available templates to be run using dotnet-new. diff --git a/documentation/manpages/sdk/dotnet-new-sdk-templates.7 b/documentation/manpages/sdk/dotnet-new-sdk-templates.7 index 8fc161631978..c4e2581a31e0 100644 --- a/documentation/manpages/sdk/dotnet-new-sdk-templates.7 +++ b/documentation/manpages/sdk/dotnet-new-sdk-templates.7 @@ -15,7 +15,7 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-sdk-templates" "7" "2025-09-15" "" ".NET Documentation" +.TH "dotnet-new-sdk-templates" "7" "2025-10-30" "" ".NET Documentation" .hy .SH NAME .PP @@ -498,7 +498,6 @@ By default, \f[I]Directory.Build.targets\f[R] files don\[cq]t inherit from paren .RS 2 .PP Specifies the framework to target. -Available since .NET Core 3.0 SDK. .PP The following table lists the default values according to the SDK version you\[cq]re using: .PP @@ -1041,7 +1040,6 @@ Excludes \f[I]launchSettings.json\f[R] from the generated template. .RS 2 .PP Specifies the framework to target. -Option not available in .NET Core 2.2 SDK. .PP The following table lists the default values according to the SDK version number you\[cq]re using: .PP @@ -1230,7 +1228,6 @@ Only applies to \f[V]Individual\f[R] or \f[V]IndividualB2C\f[R] authentication. .RS 2 .PP Specifies the framework to target. -Option available since .NET Core 3.0 SDK. .PP The following table lists the default values according to the SDK version number you\[cq]re using: .PP @@ -1495,7 +1492,6 @@ Only applies to \f[V]IndividualB2C\f[R] authentication. .RS 2 .PP Specifies the framework to target. -Option not available in .NET Core 2.2 SDK. .PP The following table lists the default values according to the SDK version number you\[cq]re using: .PP @@ -1576,6 +1572,13 @@ Specifies the version of the .NET SDK to use in the \f[I]global.json\f[R] file. The roll-forward policy to use when selecting an SDK version, either as a fallback when a specific SDK version is missing or as a directive to use a later version. For more information, see global-json. .RE +.IP \[bu] 2 +\f[B]\f[VB]--test-runner \f[B]\f[R] +.RS 2 +.PP +This option was introduced in .NET 10 SDK and specifies the test runner to use, either VSTest or Microsoft.Testing.Platform. +The default is VSTest. +.RE .SS \f[V]sln\f[R] .PP Creates an empty solution file containing no projects. @@ -1711,7 +1714,6 @@ This option only applies if authentication is \f[V]None\f[R]. .PP Specifies LocalDB should be used instead of SQLite. Only applies to \f[V]Individual\f[R] or \f[V]IndividualB2C\f[R] authentication. -Available since .NET Core 3.0 SDK. .RE .IP \[bu] 2 \f[B]\f[VB]-f|--framework \f[B]\f[R] diff --git a/documentation/manpages/sdk/dotnet-new-search.1 b/documentation/manpages/sdk/dotnet-new-search.1 index 91924986c113..4462c7d13b71 100644 --- a/documentation/manpages/sdk/dotnet-new-search.1 +++ b/documentation/manpages/sdk/dotnet-new-search.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-search" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-new-search" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new search .PP -\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET Core 5.0.300 SDK and later versions +\f[B]This article applies to:\f[R] \[u2714]\[uFE0F] .NET 6 SDK and later versions .SH NAME .PP dotnet-new-search - searches for the templates supported by dotnet-new on NuGet.org. diff --git a/documentation/manpages/sdk/dotnet-new-uninstall.1 b/documentation/manpages/sdk/dotnet-new-uninstall.1 index 7997f403986e..ef9f96b1eb9d 100644 --- a/documentation/manpages/sdk/dotnet-new-uninstall.1 +++ b/documentation/manpages/sdk/dotnet-new-uninstall.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-uninstall" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-new-uninstall" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new uninstall .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-new-uninstall - uninstalls a template package. diff --git a/documentation/manpages/sdk/dotnet-new-update.1 b/documentation/manpages/sdk/dotnet-new-update.1 index 49c560571a85..2b418db3dddd 100644 --- a/documentation/manpages/sdk/dotnet-new-update.1 +++ b/documentation/manpages/sdk/dotnet-new-update.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new-update" "1" "2025-06-13" "" ".NET Documentation" +.TH "dotnet-new-update" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new update .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-new-update - updates installed template packages. diff --git a/documentation/manpages/sdk/dotnet-new.1 b/documentation/manpages/sdk/dotnet-new.1 index 3ba477b121aa..97e2d8303a37 100644 --- a/documentation/manpages/sdk/dotnet-new.1 +++ b/documentation/manpages/sdk/dotnet-new.1 @@ -14,11 +14,11 @@ . ftr VB CB . ftr VBI CBI .\} -.TH "dotnet-new" "1" "2025-09-15" "" ".NET Documentation" +.TH "dotnet-new" "1" "2025-10-30" "" ".NET Documentation" .hy .SH dotnet new