Skip to content

Correct dotnet output-draining documentation - #907

Merged
Nikola Metulev (nmetulev) merged 1 commit into
mainfrom
nmetulev-dotnet-output-draining
Sep 21, 2026
Merged

Nikola Metulev (nmetulev) merged 1 commit into
mainfrom
nmetulev-dotnet-output-draining

Conversation

@nmetulev

Copy link
Copy Markdown
Member

Description

Correct the misleading comment that led to #898: on .NET 10, WaitForExitAsync already waits for both redirected output readers and their synchronous callbacks to finish. Clarify the streaming and callback-enabled buffered API documentation, including cancellation and downstream asynchronous-work limitations.

Comments/XML documentation only. Executable statements, including the existing redundant synchronous wait, are unchanged.

Usage Example

N/A — no command, flag, or API behavior changes.

Related Issue

Closes #898. The reported race was inferred from code, not reproduced; the runtime implementation contradicts its premise.

Type of Change

  • 📝 Documentation

Checklist

  • Inspected the diff to confirm only comments/XML documentation changed.
  • git diff --check passed.

Screenshots / Demo

N/A.

Additional Notes

The .NET 10 runtime implementation awaits both output readers through WaitUntilOutputEOF.

No builds or tests were run for this documentation-only change.

Clarify that .NET 10 WaitForExitAsync already drains redirected output and document normal callback completion and cancellation limits. No runtime behavior changes.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings September 21, 2026 21:14
@nmetulev
Nikola Metulev (nmetulev) merged commit 97dea79 into main Sep 21, 2026
14 checks passed
@nmetulev
Nikola Metulev (nmetulev) deleted the nmetulev-dotnet-output-draining branch September 21, 2026 21:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation accurately matches the .NET 10 runtime implementation.

Review effort: Balanced
Findings: None

What changed in this PR

Corrects documentation for .NET 10 process-output draining; no runtime behavior changes.

Changes:

  • Documents callback completion and cancellation limitations.
  • Corrects the misleading synchronous-wait comment.
File Description
IDotNetService.cs Clarifies output-reader callback guarantees.
DotNetService.cs Corrects WaitForExitAsync commentary.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Streamed dotnet output can drop the final lines of restore and build diagnostics

2 participants