Skip to content

Commit 2e56d4d

Browse files
authored
Merge pull request #5689 from dotnet/master
Update live with current master
2 parents cd4aef0 + 91131fa commit 2e56d4d

36 files changed

+1619
-247
lines changed

docs/core/tools/dotnet-add-package.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet add package command - .NET Core CLI
33
description: The 'dotnet add package' command provides a convenient option to add a NuGet package reference to a project.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/11/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet add package
99

@@ -15,7 +15,7 @@ ms.date: 08/11/2017
1515

1616
## Synopsis
1717

18-
`dotnet add [<PROJECT>] package <PACKAGE_NAME> [-h|--help] [-v|--version] [-f|--framework] [-n|--no-restore] [-s|--source] [--package-directory]`
18+
`dotnet add [<PROJECT>] package <PACKAGE_NAME> [-h|--help] [-f|--framework] [-n|--no-restore] [--package-directory] [-s|--source] [-v|--version]`
1919

2020
## Description
2121

@@ -25,7 +25,7 @@ The `dotnet add package` command provides a convenient option to add a package r
2525

2626
For example, adding `Newtonsoft.Json` to *ToDo.csproj* produces output similar to the following example:
2727

28-
```
28+
```console
2929
Writing C:\Users\mairaw\AppData\Local\Temp\tmp95A8.tmp
3030
info : Adding PackageReference for package 'Newtonsoft.Json' into project 'C:\projects\ToDo\ToDo.csproj'.
3131
log : Restoring packages for C:\projects\ToDo\ToDo.csproj...
@@ -57,10 +57,6 @@ The package reference to add.
5757

5858
Prints out a short help for the command.
5959

60-
`-v|--version <VERSION>`
61-
62-
Version of the package.
63-
6460
`-f|--framework <FRAMEWORK>`
6561

6662
Adds a package reference only when targeting a specific [framework](../../standard/frameworks.md).
@@ -69,13 +65,17 @@ Adds a package reference only when targeting a specific [framework](../../standa
6965

7066
Adds a package reference without performing a restore preview and compatibility check.
7167

68+
`--package-directory <PACKAGE_DIRECTORY>`
69+
70+
Restores the package to the specified directory.
71+
7272
`-s|--source <SOURCE>`
7373

7474
Uses a specific NuGet package source during the restore operation.
7575

76-
`--package-directory <PACKAGE_DIRECTORY>`
76+
`-v|--version <VERSION>`
7777

78-
Restores the package to the specified directory.
78+
Version of the package.
7979

8080
## Examples
8181

docs/core/tools/dotnet-add-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet-add reference command - .NET Core CLI
33
description: The dotnet add reference command provides a convenient option to add project to project references.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 09/19/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet-add reference
99

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: dotnet build-server command - .NET Core CLI
3+
description: The dotnet build-server interacts with servers started by a build.
4+
author: mairaw
5+
ms.author: mairaw
6+
ms.date: 05/29/2018
7+
---
8+
# dotnet-build
9+
10+
[!INCLUDE [topic-appliesto-net-core-21plus](../../../includes/topic-appliesto-net-core-21plus.md)]
11+
12+
## Name
13+
14+
`dotnet build-server` - Interacts with servers started by a build.
15+
16+
## Synopsis
17+
18+
```
19+
dotnet build-server shutdown [--msbuild] [--razor] [--vbcscompiler]
20+
dotnet build-server shutdown [-h|--help]
21+
dotnet build-server [-h|--help]
22+
```
23+
24+
## Commands
25+
26+
`shutdown`
27+
28+
Shuts down build servers that are started from dotnet. By default, all servers are shut down.
29+
30+
## Options
31+
32+
`-h|--help`
33+
34+
Prints out a short help for the command.
35+
36+
`--msbuild`
37+
38+
Shuts down the MSBuild build server.
39+
40+
`--razor`
41+
42+
Shuts down the Razor build server.
43+
44+
`--vbcscompiler`
45+
46+
Shuts down the VB/C# compiler build server.

docs/core/tools/dotnet-build.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet build command - .NET Core CLI
33
description: The dotnet build command builds a project and all of its dependencies.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 03/10/2018
6+
ms.date: 05/25/2018
77
---
88
# dotnet-build
99

@@ -35,23 +35,23 @@ The `dotnet build` command builds the project and its dependencies into a set of
3535

3636
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 need to use the [dotnet publish](dotnet-publish.md) command. For more information, see [.NET Core Application Deployment](../deploying/index.md).
3737

38-
Building requires the *project.assets.json* file, which lists the dependencies of your application. The file is created when [`dotnet restore`](dotnet-restore.md) is executed. Without the assets file in place, the tooling cannot resolve reference assemblies, which results in errors. With .NET Core 1.x SDK, you needed to explicitily run the `dotnet restore` before running `dotnet build`. Starting with .NET Core 2.0 SDK, `dotnet restore` runs implicitily when you run `dotnet build`. If you want to disable implicit restore when running the build command, you can pass the `--no-restore` option.
38+
Building requires the *project.assets.json* file, which lists the dependencies of your application. The file is created when [`dotnet restore`](dotnet-restore.md) is executed. Without the assets file in place, the tooling cannot resolve reference assemblies, which results in errors. With .NET Core 1.x SDK, you needed to explicitly run the `dotnet restore` before running `dotnet build`. Starting with .NET Core 2.0 SDK, `dotnet restore` runs implicitly when you run `dotnet build`. If you want to disable implicit restore when running the build command, you can pass the `--no-restore` option.
3939

4040
[!INCLUDE[dotnet restore note + options](~/includes/dotnet-restore-note-options.md)]
4141

42-
`dotnet build` uses MSBuild to build the project; thus, it supports both parallel and incremental builds. Refer to [Incremental Builds](/visualstudio/msbuild/incremental-builds) for more information.
42+
`dotnet build` uses MSBuild to build the project, so it supports both parallel and incremental builds. For more information, see [Incremental Builds](/visualstudio/msbuild/incremental-builds).
4343

44-
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](/visualstudio/msbuild/msbuild-command-line-reference).
44+
In addition to its options, the `dotnet build` command accepts MSBuild options, such as `/p` for setting properties or `/l` to define a logger. For more information about these options, see the [MSBuild Command-Line Reference](/visualstudio/msbuild/msbuild-command-line-reference).
4545

46-
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:
46+
Whether the project is executable or not is determined by the `<OutputType>` property in the project file. The following example shows a project that produces executable code:
4747

4848
```xml
4949
<PropertyGroup>
5050
<OutputType>Exe</OutputType>
5151
</PropertyGroup>
5252
```
5353

54-
In order to produce a library, omit the `<OutputType>` property. The main difference in built output is that the IL DLL for a library doesn't contain entry points and can't be executed.
54+
In order to produce a library, omit the `<OutputType>` property. The main difference in built output is that the IL DLL for a library doesn't contain entry points and can't be executed.
5555

5656
## Arguments
5757

@@ -73,23 +73,23 @@ Compiles for a specific [framework](../../standard/frameworks.md). The framework
7373

7474
`--force`
7575

76-
Forces all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting the *project.assets.json* file.
76+
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.
7777

7878
`-h|--help`
7979

8080
Prints out a short help for the command.
8181

8282
`--no-dependencies`
8383

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

8686
`--no-incremental`
8787

88-
Marks the build as unsafe for incremental build. This turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
88+
Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
8989

9090
`--no-restore`
9191

92-
Doesn't perform an implicit restore during build.
92+
Doesn't execute an implicit restore during build.
9393

9494
`-o|--output <OUTPUT_DIRECTORY>`
9595

@@ -123,11 +123,11 @@ Prints out a short help for the command.
123123

124124
`--no-dependencies`
125125

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

128128
`--no-incremental`
129129

130-
Marks the build as unsafe for incremental build. This turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
130+
Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
131131

132132
`-o|--output <OUTPUT_DIRECTORY>`
133133

docs/core/tools/dotnet-clean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet clean command - .NET Core CLI
33
description: The dotnet clean command cleans the current directory.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/13/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet-clean
99

docs/core/tools/dotnet-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet help command - .NET Core CLI
33
description: The dotnet help command shows more detailed documentation online for the specified command.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/17/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet help reference
99

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: dotnet list reference command - .NET Core CLI
33
description: The dotnet list reference command provides a convenient option to list project to project references.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/14/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet list reference
99

1010
[!INCLUDE [topic-appliesto-net-core-all](../../../includes/topic-appliesto-net-core-all.md)]
1111

1212
## Name
1313

14-
`dotnet list reference` - Lists project to project references.
14+
`dotnet list reference` - Lists project-to-project references.
1515

1616
## Synopsis
1717

@@ -25,7 +25,7 @@ The `dotnet list reference` command provides a convenient option to list project
2525

2626
`PROJECT`
2727

28-
Specifies the project file to use for listing references. If not specified, the command will search the current directory for a project file.
28+
Specifies the project file to use for listing references. If not specified, the command searches the current directory for a project file.
2929

3030
## Options
3131

@@ -41,4 +41,4 @@ List the project references for the specified project:
4141

4242
List the project references for the project in the current directory:
4343

44-
`dotnet list reference`
44+
`dotnet list reference`

docs/core/tools/dotnet-migrate.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet migrate command - .NET Core CLI
33
description: The dotnet migrate command migrates a project and all of its dependencies.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/14/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet migrate
99

@@ -15,24 +15,27 @@ ms.date: 08/14/2017
1515

1616
## Synopsis
1717

18-
`dotnet migrate [<SOLUTION_FILE|PROJECT_DIR>] [-t|--template-file] [-v|--sdk-package-version] [-x|--xproj-file] [-s|--skip-project-references] [-r|--report-file] [--format-report-file-json] [--skip-backup] [-h|--help]`
18+
```
19+
dotnet migrate [<SOLUTION_FILE|PROJECT_DIR>] [--format-report-file-json] [-r|--report-file] [-s|--skip-project-references] [--skip-backup] [-t|--template-file] [-v|--sdk-package-version] [-x|--xproj-file]
20+
dotnet migrate [-h|--help]
21+
```
1922

2023
## Description
2124

22-
The `dotnet migrate` command migrates a valid Preview 2 *project.json*-based project to a valid .NET Core SDK 1.0 *csproj* project.
25+
The `dotnet migrate` command migrates a valid Preview 2 *project.json*-based project to a valid .NET Core SDK 1.0 *csproj* project.
2326

24-
By default, the command migrates the root project and any project references that the root project contains. This behavior is disabled using the `--skip-project-references` option at runtime.
27+
By default, the command migrates the root project and any project references that the root project contains. This behavior is disabled using the `--skip-project-references` option at runtime.
2528

26-
Migration is performed on the following:
29+
Migration can be performed on the following assets:
2730

2831
* A single project by specifying the *project.json* file to migrate.
2932
* All of the directories specified in the *global.json* file by passing in a path to the *global.json* file.
3033
* A *solution.sln* file, where it migrates the projects referenced in the solution.
31-
* On all sub-directories of the given directory recursively.
34+
* On all subdirectories of the given directory recursively.
3235

3336
The `dotnet migrate` command keeps the migrated *project.json* file inside a `backup` directory, which it creates if the directory doesn't exist. This behavior is overridden using the `--skip-backup` option.
3437

35-
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.
38+
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.
3639

3740
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.
3841

@@ -43,45 +46,45 @@ The `dotnet migrate` command only supports valid Preview 2 *project.json*-based
4346
The path to one of the following:
4447

4548
* a *project.json* file to migrate.
46-
* a *global.json* file, it will migrate the folders specified in *global.json*.
47-
* a *solution.sln* file, it will migrate the projects referenced in the solution.
48-
* a directory to migrate, it will recursively search for *project.json* files to migrate.
49+
* a *global.json* file: the folders specified in *global.json* are migrated.
50+
* a *solution.sln* file: the projects referenced in the solution are migrated.
51+
* a directory to migrate: recursively searches for *project.json* files to migrate inside the specified directory.
4952

5053
Defaults to current directory if nothing is specified.
5154

5255
## Options
5356

54-
`-h|--help`
55-
56-
Prints out a short help for the command.
57-
58-
`-t|--template-file <TEMPLATE_FILE>`
57+
`--format-report-file-json <REPORT_FILE>`
5958

60-
Template csproj file to use for migration. By default, the same template as the one dropped by `dotnet new console` is used.
59+
Output migration report file as JSON rather than user messages.
6160

62-
`-v|--sdk-package-version <VERSION>`
61+
`-h|--help`
6362

64-
The version of the sdk package that's referenced in the migrated app. The default is the version of the SDK in `dotnet new`.
63+
Prints out a short help for the command.
6564

66-
`-x|--xproj-file <FILE>`
65+
`-r|--report-file <REPORT_FILE>`
6766

68-
The path to the xproj file to use. Required when there is more than one xproj in a project directory.
67+
Output migration report to a file in addition to the console.
6968

7069
`-s|--skip-project-references [Debug|Release]`
7170

7271
Skip migrating project references. By default, project references are migrated recursively.
7372

74-
`-r|--report-file <REPORT_FILE>`
73+
`--skip-backup`
7574

76-
Output migration report to a file in addition to the console.
75+
Skip moving *project.json*, *global.json*, and *\*.xproj* to a `backup` directory after successful migration.
7776

78-
`--format-report-file-json <REPORT_FILE>`
77+
`-t|--template-file <TEMPLATE_FILE>`
7978

80-
Output migration report file as JSON rather than user messages.
79+
Template csproj file to use for migration. By default, the same template as the one dropped by `dotnet new console` is used.
8180

82-
`--skip-backup`
81+
`-v|--sdk-package-version <VERSION>`
8382

84-
Skip moving *project.json*, *global.json*, and *\*.xproj* to a `backup` directory after successful migration.
83+
The version of the sdk package that's referenced in the migrated app. The default is the version of the SDK in `dotnet new`.
84+
85+
`-x|--xproj-file <FILE>`
86+
87+
The path to the xproj file to use. Required when there is more than one xproj in a project directory.
8588

8689
## Examples
8790

@@ -95,4 +98,4 @@ Migrate all projects that *global.json* file includes:
9598

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

98-
`dotnet migrate -s -v 1.0.0-preview4`
101+
`dotnet migrate -s -v 1.0.0-preview4`

docs/core/tools/dotnet-msbuild.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: dotnet msbuild command - .NET Core CLI
33
description: The dotnet msbuild command provides access to the MSBuild command line.
44
author: mairaw
55
ms.author: mairaw
6-
ms.date: 08/14/2017
6+
ms.date: 05/25/2018
77
---
88
# dotnet msbuild
99

@@ -21,7 +21,7 @@ ms.date: 08/14/2017
2121

2222
The `dotnet msbuild` command allows access to a fully functional MSBuild.
2323

24-
The command has the exact same capabilities as existing MSBuild command-line client. The options are all the same. Use the [MSBuild Command-Line Reference](/visualstudio/msbuild/msbuild-command-line-reference) to obtain information on the available options.
24+
The command has the exact same capabilities as existing MSBuild command-line client. The options are all the same. For more information about the available options, see the [MSBuild Command-Line Reference](/visualstudio/msbuild/msbuild-command-line-reference).
2525

2626
## Examples
2727

0 commit comments

Comments
 (0)