[WIP] Clarify dotnet watch modes and behavior - #55602
Draft
tmat wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a071c08e-ab0a-4100-8fa4-9b05d6d00bc4
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the dotnet watch reference documentation to reflect current SDK behavior, especially around watch-mode selection, file-watching sources, Hot Reload vs. rerun-on-change behavior, and implemented environment variables.
Changes:
- Clarifies how
dotnet watchselects watch modes and how behavior differs forrun,--no-hot-reload,--list, and non-runcommands. - Updates the synopsis and options list to align with current
dotnet watch --help, and expands option documentation (for example,--file,--device, and--no-restore). - Corrects and expands environment-variable documentation, including Hot Reload transport variables and iteration semantics.
Suppressed comments (1)
docs/core/tools/dotnet-watch.md:151
- The options list documents the MSBuild verbosity switch as
-v|-verbosity, but the long form should be--verbosity(double dash).
- **`-v|-verbosity <LEVEL>`**
Sets the MSBuild verbosity level. The allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, `d[etailed]`, and `diag[nostic]`.
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+27
to
+28
| [--sc|--self-contained] [-v|-verbosity <LEVEL>] | ||
| [--verbose] [--version] |
tmat
marked this pull request as draft
August 19, 2026 17:33
tmat
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the
dotnet watchreference after auditing the page against the current implementation indotnet/sdk.--no-hot-reload, non-runcommands, and--listDOTNET_WATCH_ITERATIONbehaviordotnet watch --helpImplementation evidence
The mode selection and file-set differences were checked against
dotnet/sdksources, primarily:src/Dotnet.Watch/dotnet-watch/Program.cssrc/Dotnet.Watch/Watch/HotReload/HotReloadDotNetWatcher.cssrc/Dotnet.Watch/dotnet-watch/Watch/DotNetWatcher.cssrc/Dotnet.Watch/dotnet-watch/Watch/DotNetWatch.targetssrc/Dotnet.Watch/Watch/Build/EvaluationResult.cssrc/Dotnet.Watch/dotnet-watch/Watch/StaticFileHandler.cssrc/Dotnet.Watch/Watch/UI/RestartPrompt.cssrc/Dotnet.Watch/Watch/Context/EnvironmentVariables.csValidation
dotnet watch --helpgit diff --checkpassesAI assistance was used to audit the implementation and draft the documentation changes under human direction.
Internal previews