Skip to content

Backport .NET 11 System.Diagnostics.Process API docs from dotnet/runtime#12888

Draft
adamsitnik with Copilot wants to merge 2 commits into
mainfrom
copilot/backport-xml-docs-process-api
Draft

Backport .NET 11 System.Diagnostics.Process API docs from dotnet/runtime#12888
adamsitnik with Copilot wants to merge 2 commits into
mainfrom
copilot/backport-xml-docs-process-api

Conversation

Copilot AI commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Backports XML documentation for all new .NET 11 System.Diagnostics.Process APIs. Previously all new members had "To be added" placeholder docs.

New types

  • ProcessExitStatusCanceled, ExitCode, Signal properties and constructor
  • ProcessOutputLineContent, StandardError properties and constructor
  • ProcessTextOutputExitStatus, ProcessId, StandardError, StandardOutput properties and constructor

Process — 16 new methods

  • ReadAllBytes / ReadAllBytesAsync
  • ReadAllLines / ReadAllLinesAsync — includes remarks on stderr-first ordering
  • ReadAllText / ReadAllTextAsync
  • Run(startInfo) / Run(fileName)
  • RunAndCaptureText(startInfo) / RunAndCaptureText(fileName)
  • RunAndCaptureTextAsync(startInfo) / RunAndCaptureTextAsync(fileName)
  • RunAsync(startInfo) / RunAsync(fileName)
  • StartAndForget(startInfo) / StartAndForget(fileName) — includes remarks on fire-and-forget semantics

ProcessStartInfo — 7 new members

  • Constructor overload (fileName, IEnumerable<string>)
  • InheritedHandles — includes detailed remarks on Windows (SetHandleInformation) and Unix (FD_CLOEXEC) handle inheritance behavior, concurrency caveats, and supported handle types
  • KillOnParentExit — includes remarks on Windows Job Objects and Linux prctl(PR_SET_PDEATHSIG) implementation
  • StandardErrorHandle, StandardInputHandle, StandardOutputHandle
  • StartDetached

Copilot AI changed the title Backport .NET 11 Process API XML docs from dotnet/runtime Backport .NET 11 System.Diagnostics.Process API docs from dotnet/runtime Jul 20, 2026
Copilot AI requested a review from adamsitnik July 20, 2026 11:26
@adamsitnik
adamsitnik requested a review from Copilot July 20, 2026 11:33

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.

Pull request overview

This PR backports .NET 11 System.Diagnostics.Process-related API reference documentation into this repo, replacing placeholder text for newly introduced types and members so the published docs reflect the new APIs and their behaviors.

Changes:

  • Adds descriptive summaries/values/params for new .NET 11 Process members (including run/capture and stream-reading APIs) and related new types.
  • Documents new ProcessStartInfo members (notably InheritedHandles, KillOnParentExit, standard-handle SafeFileHandle properties, and StartDetached) with detailed platform-specific remarks.
  • Improves constructor/property docs for ProcessExitStatus, ProcessOutputLine, and ProcessTextOutput.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
xml/System.Diagnostics/ProcessTextOutput.xml Replaces placeholder summaries/param docs for ProcessTextOutput and its members.
xml/System.Diagnostics/ProcessStartInfo.xml Adds detailed docs/remarks for new .NET 11 members such as handle inheritance, parent-exit behavior, and standard handle properties.
xml/System.Diagnostics/ProcessOutputLine.xml Documents the new ProcessOutputLine type and its members.
xml/System.Diagnostics/ProcessExitStatus.xml Documents the new ProcessExitStatus type, including Unix signal semantics.
xml/System.Diagnostics/Process.xml Documents new .NET 11 Process APIs for running processes and reading/capturing output.

Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/Process.xml Outdated

@adamsitnik adamsitnik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot address the feedback

Comment thread xml/System.Diagnostics/Process.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated
Comment thread xml/System.Diagnostics/ProcessStartInfo.xml Outdated

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.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Comment on lines 812 to 813
</Docs>
</Member>
<Member MemberName="KillOnParentExit">
<MemberSignature Language="C#" Value="public bool KillOnParentExit { get; set; }" />
Comment on lines 859 to 860
</Docs>
</Member>
<Member MemberName="LoadUserProfile">
<MemberSignature Language="C#" Value="public bool LoadUserProfile { get; set; }" />
Comment on lines 1329 to 1330
</Docs>
</Member>
<Member MemberName="StandardInputEncoding">
<MemberSignature Language="C#" Value="public System.Text.Encoding? StandardInputEncoding { get; set; }" />
Comment on lines 1408 to 1409
</Docs>
</Member>
<Member MemberName="StandardOutputEncoding">
<MemberSignature Language="C#" Value="public System.Text.Encoding? StandardOutputEncoding { get; set; }" />
Comment on lines 1529 to 1530
</Docs>
</Member>
<Member MemberName="UseCredentialsForNetworkingOnly">
<MemberSignature Language="C#" Value="public bool UseCredentialsForNetworkingOnly { get; set; }" />
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.

3 participants