Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix-up dotnet command docs #1705

Merged
merged 7 commits into from
Mar 21, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Minor updates
  • Loading branch information
Luke Latham committed Mar 15, 2017
commit 03ed8babbba9448983c4275013275bc942e9cd14
2 changes: 1 addition & 1 deletion docs/core/tools/dotnet-add-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-add package command provides a convenient option to add
keywords: dotnet-add, CLI, CLI command, .NET Core
author: spboyer
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand Down
6 changes: 3 additions & 3 deletions docs/core/tools/dotnet-add-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-add reference command provides a convenient option to ad
keywords: dotnet-add, CLI, CLI command, .NET Core
author: spboyer
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -16,7 +16,7 @@ ms.assetid: 5e2a3efd-443c-4f23-a1b1-a662a5387879

## Name

`dotnet-add reference` - Adds project to project references.
`dotnet-add reference` - Adds project-to-project (P2P) references.

## Synopsis

Expand All @@ -42,7 +42,7 @@ Specifies the project file. If not specified, the command will search the curren

`PROJECT_REFERENCES`

Project-to-project references to add. You can specify one or multiple projects. Globbing patterns are supported on Unix/Linux-based systems.
Project-to-project (P2P) references to add. Specify one or more projects. Globbing patterns are supported on Unix/Linux-based systems.

## Options

Expand Down
12 changes: 6 additions & 6 deletions docs/core/tools/dotnet-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-build command builds a project and all of its dependenci
keywords: dotnet-build, CLI, CLI command, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -24,15 +24,15 @@ ms.assetid: 5e1a2bc4-a919-4a86-8f33-a9b218b1fcb3

## Description

The `dotnet build` command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a `*.dll` extension and symbol files used for debugging with a `*.pdb` extension. A dependencies JSON file (`*.deps.json`) is produced that lists the dependencies of the application. A `runtime.config.json` file is produced, which specifies the shared runtime and its version for the application.
The `dotnet build` command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a *.dll* extension and symbol files used for debugging with a *.pdb* extension. A dependencies JSON file (*\*.deps.json*) is produced that lists the dependencies of the application. A *\*.runtimeconfig.json* file is produced, which specifies the shared runtime and its version for the application.

If the project has third-party dependencies, such as libraries from NuGet, they're resolved from the NuGet cache and aren't available with the project's built output. With that in mind, the product of `dotnet build` isn't ready to be transferred to another machine to run. This is in contrast to the behavior of the .NET Framework in which building an executable project (an application) produces output that's runnable on any machine where the .NET Framework is installed. To have a similar experience with .NET Core, you use the [dotnet publish](dotnet-publish.md) command. For more information, see [.NET Core Application Deployment](../deploying/index.md).

Building requires the *project.assets.json* file, which lists the dependencies of your application. The file is created when you execute [`dotnet restore`](dotnet-restore.md) before building the project. Without the assets file in place, the tooling cannot resolve reference assemblies, which will result in errors.

`dotnet build` uses MSBuild to build the project; thus, it supports both parallel and incremental builds. Refer to [Incremental Builds](https://docs.microsoft.com/visualstudio/msbuild/incremental-builds) for more information.

In addition to its options, the `dotnet build` command accepts MSBuild options, such as `/p` for setting properties or `/l` to define a logger. You can learn more about these options in the [MSBuild Command-Line Reference](https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference).
In addition to its options, the `dotnet build` command accepts MSBuild options, such as `/p` for setting properties or `/l` to define a logger. Learn more about these options in the [MSBuild Command-Line Reference](https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference).

Whether the project is executable or not is determined by the `<OutputType>` property in the project file. The following example shows a project that will produce executable code:

Expand All @@ -48,7 +48,7 @@ In order to produce a library, omit the `<OutputType>` property. The main differ

`PROJECT`

The project file to build. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in `proj` and uses that file.
The project file to build. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in *proj* and uses that file.

## Options

Expand All @@ -66,7 +66,7 @@ Compiles for a specific [framework](../../standard/frameworks.md). The framework

`-c|--configuration <CONFIGURATION>`

Defines the build configuration. If omitted, the build configuration defaults to `Debug`.
Defines the build configuration. If omitted, the build configuration defaults to `Debug`. Use `Release` build a Release configuration.

`-r|--runtime <RUNTIME_IDENTIFIER>`

Expand All @@ -82,7 +82,7 @@ Marks the build as unsafe for incremental build. This turns off incremental comp

`--no-dependencies`

Ignores project-to-project references and only builds the root project specified to build.
Ignores project-to-project (P2P) references and only builds the root project specified to build.

`-v|--verbosity <LEVEL>`

Expand Down
6 changes: 3 additions & 3 deletions docs/core/tools/dotnet-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-clean command cleans the current directory.
keywords: dotnet-clean, CLI, CLI command, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -24,13 +24,13 @@ ms.assetid: eff65fa1-bab4-4421-8260-d0a284b690b2

## Description

The `dotnet clean` command cleans the output of the previous build. It's implemented as an [MSBuild target](https://docs.microsoft.com/visualstudio/msbuild/msbuild-targets), so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (`obj`) and final output (`bin`) folders are cleaned.
The `dotnet clean` command cleans the output of the previous build. It's implemented as an [MSBuild target](https://docs.microsoft.com/visualstudio/msbuild/msbuild-targets), so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (*obj*) and final output (*bin*) folders are cleaned.

## Arguments

`PROJECT`

The MSBuild project to clean. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in `proj` and uses that file.
The MSBuild project to clean. If a project file is not specified, MSBuild searches the current working directory for a file that has a file extension that ends in *proj* and uses that file.

## Options

Expand Down
8 changes: 4 additions & 4 deletions docs/core/tools/dotnet-install-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn about the dotnet-install scripts to install the .NET Core CLI
keywords: dotnet-install, dotnet-install scripts, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand Down Expand Up @@ -64,18 +64,18 @@ Specifies the installation path. The directory is created if it doesn't exist. T

`-Architecture <ARCHITECTURE>`

Architecture of the .NET Core binaries to install. Possible values are `auto`, `x64` and `x86`. The default value is `auto`, which represents the currently running OS architecture.
Architecture of the .NET Core binaries to install. Possible values are `auto`, `x64`, and `x86`. The default value is `auto`, which represents the currently running OS architecture.

`-SharedRuntime`

If set, this switch limits installation to the shared runtime. The entire SDK isn't installed.

`-DebugSymbols`
`-DebugSymbols` (see NOTE)

If set, the installer includes debugging symbols in the installation.

> [!NOTE]
> This switch is not currently avaiable but planned for a future release.
> The `-DebugSymbols` switch is not currently avaiable but planned for a future release.

`-DryRun`

Expand Down
2 changes: 1 addition & 1 deletion docs/core/tools/dotnet-list-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-list reference command provides a convenient option to l
keywords: dotnet-list, CLI, CLI command, .NET Core
author: spboyer
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand Down
7 changes: 3 additions & 4 deletions docs/core/tools/dotnet-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-migrate command migrates a project and all of its depend
keywords: dotnet-migrate, CLI, CLI command, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand Down Expand Up @@ -39,8 +39,7 @@ The `dotnet migrate` command keeps the migrated *project.json* file inside a `ba

By default, the migration operation outputs the state of the migration process to standard output (STDOUT). If you use the `--report-file <REPORT_FILE>` option, the output is saved to the file specify.

The `dotnet migrate` command only supports valid Preview 2 *project.json*-based projects. This means that you cannot
use it to migrate DNX or Preview 1 *project.json*-based projects directly to MSBuild/csproj projects. You first need to migrate the project to a Preview 2 *project.json*-based project and then use the `dotnet migrate` command to migrate the project.
The `dotnet migrate` command only supports valid Preview 2 *project.json*-based projects. This means that you cannot use it to migrate DNX or Preview 1 *project.json*-based projects directly to MSBuild/csproj projects. You first need to manually migrate the project to a Preview 2 *project.json*-based project and then use the `dotnet migrate` command to migrate the project.

## Arguments

Expand Down Expand Up @@ -99,6 +98,6 @@ Migrate all projects that *global.json* file includes:

`dotnet migrate path/to/global.json`

Migrate only the current project and no project-to-project dependencies. Also, use a specific SDK version:
Migrate only the current project and no project-to-project (P2P) dependencies. Also, use a specific SDK version:

`dotnet migrate -s -v 1.0.0-preview4`
2 changes: 1 addition & 1 deletion docs/core/tools/dotnet-msbuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-msbuild command provides access to the MSBuild command l
keywords: dotnet-msmsbuild, CLI, CLI command, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand Down
6 changes: 3 additions & 3 deletions docs/core/tools/dotnet-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-new command creates new .NET Core projects in the curren
keywords: dotnet-new, CLI, CLI command, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -31,7 +31,7 @@ dotnet new [-h|--help]

The `dotnet new` command provides a convenient way to initialize a valid .NET Core project.

When invoked, the command calls the [template engine](https://github.com/dotnet/templating) to create the artifacts on disk based on the specified template and options.
The command calls the [template engine](https://github.com/dotnet/templating) to create the artifacts on disk based on the specified template and options.

## Arguments

Expand Down Expand Up @@ -66,7 +66,7 @@ Lists templates containing the specified name. If invoked for the `dotnet new` c

`-lang|--language {C#|F#}`

The language of the template to create. The language accepted varies by the template (see defaults in the [arguments](#arguments) section. Not valid for some templates.
The language of the template to create. The language accepted varies by the template (see defaults in the [arguments](#arguments) section). Not valid for some templates.

`-n|--name <OUTPUT_NAME>`

Expand Down
14 changes: 7 additions & 7 deletions docs/core/tools/dotnet-nuget-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-nuget-delete command deletes or unlists a package from t
keywords: dotnet-nuget-delete, CLI, CLI command, .NET Core
author: karann-msft
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -24,7 +24,7 @@ ms.assetid: 6ddffde4-c789-4e90-990e-d35f6a6565d4

## Description

The `dotnet nuget delete` command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.
The `dotnet nuget delete` command deletes or unlists a package from the server. For [nuget.org](https://www.nuget.org/), the action is to unlist the package.

## Arguments

Expand All @@ -48,7 +48,7 @@ Specifies the server URL. Supported URLs for nuget.org include `http://www.nuget

`--non-interactive`

Does not prompt for user input or confirmations.
Doesn't prompt for user input or confirmations.

`-k|--api-key <API_KEY>`

Expand All @@ -60,10 +60,10 @@ Forces command-line output in English.

## Examples

Deletes version 1.0 of package MyPackage:
Deletes version 1.0 of package `Microsoft.AspNetCore.Mvc`:

`dotnet nuget delete MyPackage 1.0`
`dotnet nuget delete Microsoft.AspNetCore.Mvc 1.0`

Deletes version 1.0 of package MyPackage, not prompting user for credentials or other input:
Deletes version 1.0 of package `Microsoft.AspNetCore.Mvc`, not prompting user for credentials or other input:

`dotnet nuget delete MyPackage 1.0 --non-interactive`
`dotnet nuget delete Microsoft.AspNetCore.Mvc 1.0 --non-interactive`
24 changes: 12 additions & 12 deletions docs/core/tools/dotnet-nuget-locals.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The dotnet-nuget-locals command clears or lists local NuGet resourc
keywords: dotnet-nuget-locals, CLI, CLI command, .NET Core
author: karann-msft
ms.author: mairaw
ms.date: 03/09/2017
ms.date: 03/15/2017
ms.topic: article
ms.prod: .net-core
ms.technology: dotnet-cli
Expand All @@ -16,15 +16,15 @@ ms.assetid: 8440229e-317e-4dc1-9463-cba5fdb12c3b

## Name

`dotnet-nuget locals` - Clears or lists local NuGet resources such as http-request cache, temporary cache, or machine-wide global packages folder.
`dotnet-nuget locals` - Clears or lists local NuGet resources.

## Synopsis

`dotnet nuget locals <CACHE_LOCATION> [(-c|--clear)|(-l|--list)] [--force-english-output] [-h|--help]`

## Description

The `dotnet nuget locals` command clears or lists local NuGet resources such as http-request cache, temporary cache, or machine-wide global packages folder.
The `dotnet nuget locals` command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.

## Arguments

Expand All @@ -34,19 +34,19 @@ One of the following values:

`all`

Indicates that the specified operation should be applied to all the cache types: http-request cache, global packages cache, and the temporary cache.
Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache.

`http-cache`

Indicates that the specified operation should be applied only to the http-request cache. The other cache locations are not affected.
Indicates that the specified operation is applied only to the http-request cache. The other cache locations are not affected.

`global-packages`

Indicates that the specified operation should be applied only to the global packages cache. The other cache locations are not affected.
Indicates that the specified operation is applied only to the global packages cache. The other cache locations are not affected.

`temp`

Indicates that the specified operation should be applied only to the temporary cache. The other cache locations are not affected.
Indicates that the specified operation is applied only to the temporary cache. The other cache locations are not affected.

## Options

Expand All @@ -56,7 +56,7 @@ Prints out a short help for the command.

`-c|--clear`

The clear option is used to perform a clear operation on the specified cache type. The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders which were not cleared.
The clear option performs a clear operation on the specified cache type. The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders which were not cleared.

`-l|--list`

Expand All @@ -76,18 +76,18 @@ Displays the path for the local http-cache directory:

`dotnet nuget locals --list http-cache`

Clears all the files in all the local cache directories (http-cache directory, global-packages cache directory, and temporary cache directory):
Clears all files from all local cache directories (http-cache directory, global-packages cache directory, and temporary cache directory):

`dotnet nuget locals --clear all`

Clears all the files in local global-packages cache directory:
Clears all files in local global-packages cache directory:

`dotnet nuget locals -c global-packages`

Clears all the files in local temporary cache directory:
Clears all files in local temporary cache directory:

`dotnet nuget locals -c temp`

## Troubleshooting

For information on common problems and errors while using the `dotnet nuget locals` command, see [Managing the NuGet cache](https://docs.microsoft.com/nuget/consume-packages/managing-the-nuget-cache).
For information on common problems and errors while using the `dotnet nuget locals` command, see [Managing the NuGet cache](https://docs.microsoft.com/nuget/consume-packages/managing-the-nuget-cache).
Loading