From b0a9b067f881d515efce6f975a33c970a667167e Mon Sep 17 00:00:00 2001 From: Forgind <12969783+Forgind@users.noreply.github.com> Date: Mon, 9 Dec 2024 18:16:35 -0500 Subject: [PATCH] Switch from dvn to dnv (dotnet verb noun to dotnet noun verb) This is for the dotnet package/reference add/list/remove commands. --- ...t-add-package.md => dotnet-package-add.md} | 30 ++++++++-------- ...list-package.md => dotnet-package-list.md} | 34 +++++++++---------- ...ve-package.md => dotnet-package-remove.md} | 16 ++++----- ...d-reference.md => dotnet-reference-add.md} | 22 ++++++------ ...-reference.md => dotnet-reference-list.md} | 18 +++++----- ...eference.md => dotnet-reference-remove.md} | 20 +++++------ 6 files changed, 70 insertions(+), 70 deletions(-) rename docs/core/tools/{dotnet-add-package.md => dotnet-package-add.md} (87%) rename docs/core/tools/{dotnet-list-package.md => dotnet-package-list.md} (86%) rename docs/core/tools/{dotnet-remove-package.md => dotnet-package-remove.md} (62%) rename docs/core/tools/{dotnet-add-reference.md => dotnet-reference-add.md} (75%) rename docs/core/tools/{dotnet-list-reference.md => dotnet-reference-list.md} (62%) rename docs/core/tools/{dotnet-remove-reference.md => dotnet-reference-remove.md} (67%) diff --git a/docs/core/tools/dotnet-add-package.md b/docs/core/tools/dotnet-package-add.md similarity index 87% rename from docs/core/tools/dotnet-add-package.md rename to docs/core/tools/dotnet-package-add.md index aded0480bcd83..89d6f982bb6e6 100644 --- a/docs/core/tools/dotnet-add-package.md +++ b/docs/core/tools/dotnet-package-add.md @@ -1,30 +1,30 @@ --- -title: dotnet add package command -description: The 'dotnet add package' command provides a convenient option to add a NuGet package reference to a project. +title: dotnet package add command +description: The 'dotnet package add' command provides a convenient option to add a NuGet package reference to a project. ms.date: 04/13/2022 --- -# dotnet add package +# dotnet package add **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions ## Name -`dotnet add package` - Adds or updates a package reference in a project file. +`dotnet package add` - Adds or updates a package reference in a project file. ## Synopsis ```dotnetcli -dotnet add [] package - [-f|--framework ] [--interactive] +dotnet package add + [-f|--framework ] [--interactive] [--project ] [-n|--no-restore] [--package-directory ] [--prerelease] [-s|--source ] [-v|--version ] -dotnet add package -h|--help +dotnet package add -h|--help ``` ## Description -The `dotnet add package` command provides a convenient option to add or update a package reference in a project file. When you run the command, there's a compatibility check to ensure the package is compatible with the frameworks in the project. If the check passes and the package isn't referenced in the project file, a `` element is added to the project file. If the check passes and the package is already referenced in the project file, the `` element is updated to the latest compatible version. After the project file is updated, [dotnet restore](dotnet-restore.md) is run. +The `dotnet package add` command provides a convenient option to add or update a package reference in a project file. When you run the command, there's a compatibility check to ensure the package is compatible with the frameworks in the project. If the check passes and the package isn't referenced in the project file, a `` element is added to the project file. If the check passes and the package is already referenced in the project file, the `` element is updated to the latest compatible version. After the project file is updated, [dotnet restore](dotnet-restore.md) is run. For example, adding `Microsoft.EntityFrameworkCore` to *ToDo.csproj* produces output similar to the following example: @@ -57,7 +57,7 @@ The following scenarios are currently supported. These examples assume that the Scenario 1: `` does not exist in the project file, `` element does not exist in the `Directory.Packages.props file`, and the version argument is not passed from the commandline. - CLI command that is executed: `dotnet add ToDo.csproj package Microsoft.EntityFrameworkCore` + CLI command that is executed: `dotnet package add Microsoft.EntityFrameworkCore --project ToDo.csproj` The `` element is added to the `Directory.Packages.props file`. @@ -73,7 +73,7 @@ Scenario 1: `` does not exist in the project file, `` does not exist in the project file, `` element does not exist in the `Directory.Packages.props file`, and the version argument is passed from the commandline. - CLI command that is executed: `dotnet add ToDo.csproj package Microsoft.EntityFrameworkCore --version 5.0.4` + CLI command that is executed: `dotnet package add Microsoft.EntityFrameworkCore --version 5.0.4 --project ToDo.csproj` The `` element is added to the `Directory.Packages.props file`. @@ -89,7 +89,7 @@ Scenario 2: `` does not exist in the project file, `` does not exist in the project file, `` element does exist in the `Directory.Packages.props file`, and the version argument is not passed from the commandline. - CLI command that is executed: `dotnet add ToDo.csproj package Microsoft.EntityFrameworkCore` + CLI command that is executed: `dotnet package add Microsoft.EntityFrameworkCore --project ToDo.csproj` The `` element is added to the `Directory.Packages.props file`. @@ -105,7 +105,7 @@ The `` element is added to the project file. Scenario 4: `` does not exist in the project file, `` element does exist in the `Directory.Packages.props file`, and the version argument is passed from the commandline. - CLI command that is executed: `dotnet add ToDo.csproj package Microsoft.EntityFrameworkCore --version 5.0.4` + CLI command that is executed: `dotnet package add Microsoft.EntityFrameworkCore --version 5.0.4 --project ToDo.csproj` The `` element is added to the `Directory.Packages.props file`. @@ -168,19 +168,19 @@ Scenario 4: `` does not exist in the project file, `|] package [--config ] - [--deprecated] +dotnet package list [--config ] + [--deprecated] [--project [|]] [-f|--framework ] [--highest-minor] [--highest-patch] [--include-prerelease] [--include-transitive] [--interactive] [--outdated] [--source ] [-v|--verbosity ] @@ -23,12 +23,12 @@ dotnet list [|] package [--config ] [--format ] [--output-version ] -dotnet list package -h|--help +dotnet package list -h|--help ``` ## Description -The `dotnet list package` command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process. The following example shows the output of the `dotnet list package` command for the [SentimentAnalysis](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) project: +The `dotnet package list` command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process. The following example shows the output of the `dotnet package list` command for the [SentimentAnalysis](https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) project: ```output Project 'SentimentAnalysis' has the following package references @@ -44,7 +44,7 @@ The **Requested** column refers to the package version specified in the project Use the `--outdated` option to find out if there are newer versions available of the packages you're using in your projects. By default, `--outdated` lists the latest stable packages unless the resolved version is also a prerelease version. To include prerelease versions when listing newer versions, also specify the `--include-prerelease` option. To update a package to the latest version, use [dotnet add package](dotnet-add-package.md). -The following example shows the output of the `dotnet list package --outdated --include-prerelease` command for the same project as the previous example: +The following example shows the output of the `dotnet package list --outdated --include-prerelease` command for the same project as the previous example: ```output The following sources were used: @@ -57,7 +57,7 @@ Project `SentimentAnalysis` has the following updates to its packages > Microsoft.ML 1.4.0 1.4.0 1.5.0-preview ``` -If you need to find out whether your project has transitive dependencies, use the `--include-transitive` option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the `dotnet list package --include-transitive` command for the [HelloPlugin](https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on: +If you need to find out whether your project has transitive dependencies, use the `--include-transitive` option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the `dotnet package list --include-transitive` command for the [HelloPlugin](https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on: ```output Project 'HelloPlugin' has the following package references @@ -133,41 +133,41 @@ The project or solution file to operate on. If not specified, the command search - List package references of a specific project: ```dotnetcli - dotnet list SentimentAnalysis.csproj package + dotnet package list --project SentimentAnalysis.csproj ``` - List package references that have newer versions available, including prerelease versions: ```dotnetcli - dotnet list package --outdated --include-prerelease + dotnet package list --outdated --include-prerelease ``` - List package references for a specific target framework: ```dotnetcli - dotnet list package --framework netcoreapp3.0 + dotnet package list --framework netcoreapp3.0 ``` - List package references in machine readable json output format: ```dotnetcli - dotnet list package --format json + dotnet package list --format json ``` - List package references for a specific target framework in machine readable json output format: ```dotnetcli - dotnet list package --framework netcoreapp3.0 --format json + dotnet package list --framework netcoreapp3.0 --format json ``` - Save machine readable json output of package references, including transitive dependency and vulnerability details into a file: ```dotnetcli - dotnet list package --include-transitive --vulnerable --format json >> dependencyReport.json + dotnet package list --include-transitive --vulnerable --format json >> dependencyReport.json ``` - List package references in machine readable json output format with output version 1: ```dotnetcli - dotnet list package --format json --output-version 1 + dotnet package list --format json --output-version 1 ``` diff --git a/docs/core/tools/dotnet-remove-package.md b/docs/core/tools/dotnet-package-remove.md similarity index 62% rename from docs/core/tools/dotnet-remove-package.md rename to docs/core/tools/dotnet-package-remove.md index 905654ca72e03..49de7f84276a6 100644 --- a/docs/core/tools/dotnet-remove-package.md +++ b/docs/core/tools/dotnet-package-remove.md @@ -1,27 +1,27 @@ --- -title: dotnet remove package command -description: The dotnet remove package command provides a convenient option to remove NuGet package reference to a project. +title: dotnet package remove command +description: The dotnet package remove command provides a convenient option to remove NuGet package reference to a project. ms.date: 02/14/2020 --- -# dotnet remove package +# dotnet package remove **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions ## Name -`dotnet remove package` - Removes package reference from a project file. +`dotnet package remove` - Removes package reference from a project file. ## Synopsis ```dotnetcli -dotnet remove [] package +dotnet package remove [--project ] -dotnet remove package -h|--help +dotnet package remove -h|--help ``` ## Description -The `dotnet remove package` command provides a convenient option to remove a NuGet package reference from a project. +The `dotnet package remove` command provides a convenient option to remove a NuGet package reference from a project. ## Arguments @@ -42,5 +42,5 @@ The package reference to remove. - Remove `Newtonsoft.Json` NuGet package from a project in the current directory: ```dotnetcli - dotnet remove package Newtonsoft.Json + dotnet package remove Newtonsoft.Json ``` diff --git a/docs/core/tools/dotnet-add-reference.md b/docs/core/tools/dotnet-reference-add.md similarity index 75% rename from docs/core/tools/dotnet-add-reference.md rename to docs/core/tools/dotnet-reference-add.md index d554dfb82a99a..7a3a9fb8e199a 100644 --- a/docs/core/tools/dotnet-add-reference.md +++ b/docs/core/tools/dotnet-reference-add.md @@ -1,28 +1,28 @@ --- -title: dotnet add reference command -description: The dotnet add reference command provides a convenient option to add project-to-project references. +title: dotnet reference add command +description: The dotnet reference add command provides a convenient option to add project-to-project references. ms.date: 03/21/2023 --- -# dotnet add reference +# dotnet reference add **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions ## Name -`dotnet add reference` - Adds project-to-project (P2P) references. +`dotnet reference add` - Adds project-to-project (P2P) references. ## Synopsis ```dotnetcli -dotnet add [] reference [-f|--framework ] - [--interactive] +dotnet reference add reference [-f|--framework ] + [--interactive] [--project ] -dotnet add reference -h|--help +dotnet reference add -h|--help ``` ## Description -The `dotnet add reference` command provides a convenient option to add project references to a project. After running the command, the `` elements are added to the project file. +The `dotnet reference add` command provides a convenient option to add project references to a project. After running the command, the `` elements are added to the project file. ```xml @@ -69,17 +69,17 @@ There's no CLI command to add a reference to an assembly that isn't in a project - Add a project reference: ```dotnetcli - dotnet add app/app.csproj reference lib/lib.csproj + dotnet reference add lib/lib.csproj --project app/app.csproj ``` - Add multiple project references to the project in the current directory: ```dotnetcli - dotnet add reference lib1/lib1.csproj lib2/lib2.csproj + dotnet reference add lib1/lib1.csproj lib2/lib2.csproj ``` - Add multiple project references using a globbing pattern on Linux/Unix: ```dotnetcli - dotnet add app/app.csproj reference **/*.csproj + dotnet reference add **/*.csproj --project app/app.csproj ``` diff --git a/docs/core/tools/dotnet-list-reference.md b/docs/core/tools/dotnet-reference-list.md similarity index 62% rename from docs/core/tools/dotnet-list-reference.md rename to docs/core/tools/dotnet-reference-list.md index 2ab39806996d9..e3e3915cae2ac 100644 --- a/docs/core/tools/dotnet-list-reference.md +++ b/docs/core/tools/dotnet-reference-list.md @@ -1,27 +1,27 @@ --- -title: dotnet list reference command -description: The dotnet list reference command provides a convenient option to list project to project references. +title: dotnet reference list command +description: The dotnet reference list command provides a convenient option to list project to project references. ms.date: 02/14/2020 --- -# dotnet list reference +# dotnet reference list **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions ## Name -`dotnet list reference` - Lists project-to-project references. +`dotnet reference list` - Lists project-to-project references. ## Synopsis ```dotnetcli -dotnet list [] reference +dotnet reference list [--project ] -dotnet list -h|--help +dotnet reference list -h|--help ``` ## Description -The `dotnet list reference` command provides a convenient option to list project references for a given project. +The `dotnet reference list` command provides a convenient option to list project references for a given project. ## Arguments @@ -38,11 +38,11 @@ The `dotnet list reference` command provides a convenient option to list project * List the project references for the specified project: ```dotnetcli - dotnet list app/app.csproj reference + dotnet reference list --project app/app.csproj ``` * List the project references for the project in the current directory: ```dotnetcli - dotnet list reference + dotnet reference list ``` diff --git a/docs/core/tools/dotnet-remove-reference.md b/docs/core/tools/dotnet-reference-remove.md similarity index 67% rename from docs/core/tools/dotnet-remove-reference.md rename to docs/core/tools/dotnet-reference-remove.md index ac9d7f117cf92..6041465459276 100644 --- a/docs/core/tools/dotnet-remove-reference.md +++ b/docs/core/tools/dotnet-reference-remove.md @@ -1,28 +1,28 @@ --- -title: dotnet remove reference command -description: The dotnet remove reference command provides a convenient option to remove project to project references. +title: dotnet reference remove command +description: The dotnet reference remove command provides a convenient option to remove project to project references. ms.date: 02/14/2020 --- -# dotnet remove reference +# dotnet reference remove **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions ## Name -`dotnet remove reference` - Removes project-to-project (P2P) references. +`dotnet reference remove` - Removes project-to-project (P2P) references. ## Synopsis ```dotnetcli -dotnet remove [] reference [-f|--framework ] +dotnet reference remove [-f|--framework ] [--project ] -dotnet remove reference -h|--help +dotnet reference remove -h|--help ``` ## Description -The `dotnet remove reference` command provides a convenient option to remove project references from a project. +The `dotnet reference remove` command provides a convenient option to remove project references from a project. ## Arguments @@ -47,17 +47,17 @@ Project-to-project (P2P) references to remove. You can specify one or multiple p - Remove a project reference from the specified project: ```dotnetcli - dotnet remove app/app.csproj reference lib/lib.csproj + dotnet reference remove lib/lib.csproj --project app/app.csproj ``` - Remove multiple project references from the project in the current directory: ```dotnetcli - dotnet remove reference lib1/lib1.csproj lib2/lib2.csproj + dotnet reference remove lib1/lib1.csproj lib2/lib2.csproj ``` - Remove multiple project references using a glob pattern on Unix/Linux: ```dotnetcli - dotnet remove app/app.csproj reference **/*.csproj` + dotnet reference remove **/*.csproj` --project app/app.csproj ```