Fix-up dotnet command docs #1705
Conversation
|
@guardrex, |
| dotnet add [project] package <package_name> [-v|--version] [-f|--framework] [-n|--no-restore] [-s|--source] [--package-directory] | ||
| dotnet add package [-h|--help] | ||
| ``` | ||
| `dotnet add [<PROJECT>] package <PACKAGE_NAME> [-v|--version <VERSION>] [-f|--framework <FRAMEWORK>] [-n|--no-restore] [-s|--source <SOURCE>] [--package-directory <PACKAGE_DIRECTORY>] [-h|--help]` |
There was a problem hiding this comment.
[<PROJECT>]-> [PROJECT] (it should just have the optional indicator)
There was a problem hiding this comment.
I was following an existing pattern where if it was optional it has brackets; but if optional and user-supplied, it would get both brackets and angle brackets.
If you prefer it be brackets only, I'll update it everywhere. A bunch of the commands have this.
There was a problem hiding this comment.
Let's leave as-is for now and I'll think about this
| dotnet add [project] reference [-f|--framework] <project_references> | ||
| dotnet add reference [-h|--help] | ||
| ``` | ||
| `dotnet add [<PROJECT>] reference [-f|--framework <FRAMEWORK>] <PROJECT_REFERENCES> [-h|--help]` |
There was a problem hiding this comment.
I'd prefer not to add the options parameters in the synopsis. This could get long. And same comment for PROJECT as in the previous command.
docs/core/tools/dotnet-build.md
Outdated
|
|
||
| In addition to its options, the `dotnet build` command will accept MSBuild options as well, such as `/p` for setting properties or `/l` to define a logger. You can find out more about these options in the [`dotnet msbuild`](dotnet-msbuild.md) command documentation. | ||
| `dotnet build` uses MSBuild to build the project; thus, it supports both parallel and incremental builds. Refer to [MSBuild documentation](https://docs.microsoft.com/visualstudio/msbuild/msbuild) for more information. |
There was a problem hiding this comment.
for incremental, I'm wondering if we should link directly to the topic: https://docs.microsoft.com/visualstudio/msbuild/incremental-builds
docs/core/tools/dotnet-build.md
Outdated
|
|
||
| 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: | ||
| 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 [`dotnet msbuild`](dotnet-msbuild.md) command documentation. |
There was a problem hiding this comment.
the dotnet-msbuild topic actually doesn't cover them in detail. let's link to https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference
docs/core/tools/dotnet-clean.md
Outdated
|
|
||
| ## Description | ||
|
|
||
| The `dotnet clean` command will clean the output of the previous build. It is implemented as an MSBuild target, so the project will get evaluated. Only the outputs that were 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, 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. |
There was a problem hiding this comment.
MSBuild target -> link to https://docs.microsoft.com/visualstudio/msbuild/msbuild-targets?
docs/core/tools/dotnet-clean.md
Outdated
| @@ -36,19 +40,19 @@ Prints out a short help for the command. | |||
|
|
|||
| `-o|--output <OUTPUT_DIRECTORY>` | |||
|
|
|||
| Directory in which the built binaries were placed. You also need to define `--framework` when you specify this option. If you didn't specify this property during build time, you don't have to specify it for clean. | |||
| Directory in which the build outputs have been placed. | |||
There was a problem hiding this comment.
the rest of the info is not needed (even if rewritten for better grammar)?
There was a problem hiding this comment.
It's on the framework switch, but I added a line back to cover it on the output switch.
|
@mairaw Found a bunch of little things to touch-up. I'm happy now. 😀 |
docs/core/tools/dotnet-restore.md
Outdated
|
|
||
| ## Options | ||
|
|
||
| `root` | ||
| `ROOT` |
There was a problem hiding this comment.
we started separating arguments from options. this one is still combined.
| * [dotnet-remove package](dotnet-remove-package.md) | ||
| ### General | ||
|
|
||
| Command | Function |
There was a problem hiding this comment.
the table makes it look so much cleaner. Great job!
Fixes #1656
Notes