Skip to content

Commit bb0eda8

Browse files
authored
Update includes files for .NET CLI (#50088)
* Update includes files for .NET CLI * standardize include files * apply suggestions from review
1 parent 6f7409d commit bb0eda8

File tree

97 files changed

+318
-410
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+318
-410
lines changed

docs/core/tools/dotnet-build-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ dotnet build-server -h|--help
2929

3030
## Options
3131

32-
[!INCLUDE [help](../../../includes/cli-help.md)]
32+
- [!INCLUDE [help](../../../includes/cli-help.md)]
3333

3434
- **`--msbuild`**
3535

docs/core/tools/dotnet-build.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ Running `dotnet build` is equivalent to running `dotnet msbuild -restore`; howev
7777

7878
## Options
7979

80-
[!INCLUDE [arch](../../../includes/cli-arch.md)]
80+
- [!INCLUDE [arch](../../../includes/cli-arch.md)]
8181

82-
[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
82+
- [!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
8383

84-
[!INCLUDE [configuration](../../../includes/cli-configuration.md)]
84+
- [!INCLUDE [configuration](../../../includes/cli-configuration.md)]
8585

86-
[!INCLUDE [disable-build-servers](../../../includes/cli-disable-build-servers.md)]
86+
- [!INCLUDE [disable-build-servers](../../../includes/cli-disable-build-servers.md)]
8787

8888
- **`-f|--framework <FRAMEWORK>`**
8989

@@ -93,7 +93,7 @@ Running `dotnet build` is equivalent to running `dotnet msbuild -restore`; howev
9393

9494
Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the *project.assets.json* file.
9595

96-
[!INCLUDE [interactive](../../../includes/cli-interactive-3-0.md)]
96+
- [!INCLUDE [interactive](../../../includes/cli-interactive.md)]
9797

9898
- **`--no-dependencies`**
9999

@@ -111,7 +111,7 @@ Running `dotnet build` is equivalent to running `dotnet msbuild -restore`; howev
111111

112112
Doesn't display the startup banner or the copyright message.
113113

114-
[!INCLUDE [no-self-contained](../../../includes/cli-no-self-contained.md)]
114+
- [!INCLUDE [no-self-contained](../../../includes/cli-no-self-contained.md)]
115115

116116
- **`-o|--output <OUTPUT_DIRECTORY>`**
117117

@@ -121,7 +121,7 @@ Running `dotnet build` is equivalent to running `dotnet msbuild -restore`; howev
121121

122122
If you specify the `--output` 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 `--output` option is disallowed because all outputs of all built projects would be copied into the specified directory, which isn'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 `--output` option no longer valid for build-related commands](../compatibility/sdk/7.0/solution-level-output-no-longer-valid.md).
123123

124-
[!INCLUDE [os](../../../includes/cli-os.md)]
124+
- [!INCLUDE [os](../../../includes/cli-os.md)]
125125

126126
- **`-p|--property:<PROPERTYNAME>=<VALUE>`**
127127

@@ -136,23 +136,23 @@ Running `dotnet build` is equivalent to running `dotnet msbuild -restore`; howev
136136

137137
Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the [RID catalog](../rid-catalog.md). If you use this option with .NET 6 SDK, use `--self-contained` or `--no-self-contained` also. If not specified, the default is to build for the current OS and architecture.
138138

139-
[!INCLUDE [self-contained](../../../includes/cli-self-contained.md)]
139+
- [!INCLUDE [self-contained](../../../includes/cli-self-contained.md)]
140140

141141
- **`--source <SOURCE>`**
142142

143143
The URI of the NuGet package source to use during the restore operation.
144144

145-
[!INCLUDE [tl](../../../includes/cli-tl.md)]
145+
- [!INCLUDE [tl](../../../includes/cli-tl.md)]
146146

147-
[!INCLUDE [use-current-runtime](../../../includes/cli-use-current-runtime.md)]
147+
- [!INCLUDE [use-current-runtime](../../../includes/cli-use-current-runtime.md)]
148148

149-
[!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
149+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
150150

151151
- **`--version-suffix <VERSION_SUFFIX>`**
152152

153153
Sets the value of the `$(VersionSuffix)` property to use when building the project. This only works if the `$(Version)` property isn't set. Then, `$(Version)` is set to the `$(VersionPrefix)` combined with the `$(VersionSuffix)`, separated by a dash.
154154

155-
[!INCLUDE [help](../../../includes/cli-help.md)]
155+
- [!INCLUDE [help](../../../includes/cli-help.md)]
156156

157157
## Examples
158158

docs/core/tools/dotnet-clean.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ The `dotnet clean` command cleans the output of the previous build. It's impleme
3434

3535
## Options
3636

37-
[!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
37+
- [!INCLUDE [artifacts-path](../../../includes/cli-artifacts-path.md)]
3838

39-
[!INCLUDE [configuration](../../../includes/cli-configuration-clean.md)]
39+
- [!INCLUDE [configuration](../../../includes/cli-configuration-clean.md)]
4040

4141
- **`-f|--framework <FRAMEWORK>`**
4242

4343
The [framework](../../standard/frameworks.md) that was specified at build time. The framework must be defined in the [project file](../project-sdk/overview.md). If you specified the framework at build time, you must specify the framework when cleaning.
4444

45-
[!INCLUDE [help](../../../includes/cli-help.md)]
45+
- [!INCLUDE [help](../../../includes/cli-help.md)]
4646

47-
[!INCLUDE [interactive](../../../includes/cli-interactive-3-0.md)]
47+
- [!INCLUDE [interactive](../../../includes/cli-interactive.md)]
4848

4949
- **`--nologo`**
5050

@@ -62,9 +62,9 @@ The `dotnet clean` command cleans the output of the previous build. It's impleme
6262

6363
Cleans the output folder of the specified runtime. This is used when a [self-contained deployment](../deploying/index.md#self-contained-deployment) was created.
6464

65-
[!INCLUDE [tl](../../../includes/cli-tl.md)]
65+
- [!INCLUDE [tl](../../../includes/cli-tl.md)]
6666

67-
[!INCLUDE [verbosity](../../../includes/cli-verbosity-normal.md)]
67+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity-normal.md)]
6868

6969
## Examples
7070

docs/core/tools/dotnet-format.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ None of the options below are required for the `dotnet format` command to succee
8282

8383
Displays version information.
8484

85-
[!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
85+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
8686

87-
[!INCLUDE [help](../../../includes/cli-help.md)]
87+
- [!INCLUDE [help](../../../includes/cli-help.md)]
8888

8989
## Subcommands
9090

docs/core/tools/dotnet-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The `dotnet help` command opens up the reference page for more detailed informat
2929

3030
## Options
3131

32-
[!INCLUDE [help](../../../includes/cli-help.md)]
32+
- [!INCLUDE [help](../../../includes/cli-help.md)]
3333

3434
## Examples
3535

docs/core/tools/dotnet-new-details.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,13 @@ If the package is installed locally or is found on the official NuGet website, i
3636
By default, `dotnet new details` uses the hierarchy of NuGet configuration files from the current directory to determine the NuGet source the package can be installed from. If `--nuget-source` is specified, the source is added to the list of sources to be checked.
3737
To check the configured sources for the current directory use [`dotnet nuget list source`](dotnet-nuget-list-source.md). For more information, see [Common NuGet Configurations](/nuget/consume-packages/configuring-nuget-behavior).
3838

39-
[!INCLUDE [interactive](../../../includes/cli-interactive.md)]
39+
- [!INCLUDE [interactive](../../../includes/cli-interactive.md)]
4040

4141
- **`-d|--diagnostics`**
4242

4343
Enables diagnostic output.
4444

45-
- **`-h|--help`**
46-
47-
Displays help for the search command.
45+
- [!INCLUDE [help](../../../includes/cli-help.md)]
4846

4947
## Examples
5048

docs/core/tools/dotnet-new-install.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,11 @@ Starting with .NET SDK 6.0.100, installed template packages are available in lat
7070
7171
Allows installing template packages from the specified sources even if they would override a template package from another source. Available since .NET SDK 7.0.100.
7272
73-
- **`-h|--help`**
73+
- [!INCLUDE [help](../../../includes/cli-help.md)]
7474
75-
Prints out help for the install command. Available since .NET SDK 7.0.100.
75+
- [!INCLUDE [interactive](../../../includes/cli-interactive.md)]
7676
77-
[!INCLUDE [interactive](../../../includes/cli-interactive-5-0.md)]
78-
79-
- **`-v|--verbosity <LEVEL>`**
80-
81-
Sets the verbosity level of the command. Allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, and `diag[nostic]`. Available since .NET SDK 7.0.100.
77+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
8278
8379
## Examples
8480

docs/core/tools/dotnet-new-list.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ Starting with .NET SDK 7.0.100, the `list` command might not show all the templa
7575
7676
Enables diagnostic output. Available since .NET SDK 7.0.100.
7777
78-
- **`-h|--help`**
79-
80-
Prints out help for the list command. Available since .NET SDK 7.0.100.
78+
- [!INCLUDE [help](../../../includes/cli-help.md)]
8179
8280
- **`--ignore-constraints`**
8381
@@ -106,9 +104,7 @@ Starting with .NET SDK 7.0.100, the `list` command might not show all the templa
106104
107105
Filters templates based on template type. Predefined values are `project`, `item`, and `solution`.
108106
109-
- **`-v|--verbosity <LEVEL>`**
110-
111-
Sets the verbosity level of the command. Allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, and `diag[nostic]`. Available since .NET SDK 7.0.100.
107+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
112108
113109
## Examples
114110

docs/core/tools/dotnet-new-search.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,7 @@ The `dotnet new search` command searches for templates supported by `dotnet new`
7272
7373
Enables diagnostic output. Available since .NET SDK 7.0.100.
7474
75-
- **`-h|--help`**
76-
77-
Prints out help for the search command. Available since .NET SDK 7.0.100.
75+
- [!INCLUDE [help](../../../includes/cli-help.md)]
7876
7977
- **`-lang|--language <language>`**
8078

docs/core/tools/dotnet-new-uninstall.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,9 @@ The `dotnet new uninstall` command uninstalls a template package at the `PATH` o
5151
5252
Enables diagnostic output. Available since .NET SDK 7.0.100.
5353
54-
- **`-h|--help`**
54+
- [!INCLUDE [help](../../../includes/cli-help.md)]
5555
56-
Prints out help for the uninstall command. Available since .NET SDK 7.0.100.
57-
58-
- **`-v|--verbosity <LEVEL>`**
59-
60-
Sets the verbosity level of the command. Allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, and `diag[nostic]`. Available since .NET SDK 7.0.100.
56+
- [!INCLUDE [verbosity](../../../includes/cli-verbosity.md)]
6157
6258
## Examples
6359

0 commit comments

Comments
 (0)