Skip to content

Document custom debugger initialization on mobile platforms - #56220

Merged
jkotas merged 2 commits into
mainfrom
vitek-karas-mobile-debugger-initialization
Sep 25, 2026
Merged

jkotas merged 2 commits into
mainfrom
vitek-karas-mobile-debugger-initialization

Conversation

@vitek-karas

@vitek-karas vitek-karas commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add a guide for custom ICorDebug-based debugger initialization in .NET 11 mobile apps that use CoreCLR.
  • Cover the in-process profiler component, native library deployment, startup configuration, debugger creation, and attachment ordering. Link to the official .NET profiler samples.
  • Add the guide to the debugging overview and the tools/diagnostics navigation. Exclude NativeAOT and avoid implying general-purpose mobile profiler support.

Content sources and authorship

Adapted from an engineering outline, with AI-assisted drafting followed by author revisions. No source prose was copied verbatim; the article retains ai-usage: ai-generated.

Source area Treatment
Title and architecture Adapted; author revised the mobile in-process rationale.
Profiler startup mechanism Adapted; verified the DllGetClassObject export and linked the official samples.
DBI/DAC deployment Adapted; author refined the deployment requirements.
DBI creation API Adapted; recommends CoreCLRCreateCordbObjectEx.
Startup configuration Adapted to the documented DOTNET_ environment variables.
Startup synchronization Adapted to a concise attachment-order requirement.
Profiler-interface-version guidance Omitted to keep the guide focused on initialization.
General debugger responsibilities Reduced to the normal Unix ICorDebug model after initialization.

The API lifecycle links, scope clarifications, and navigation entries are newly added material. Technical review should focus on the mobile-specific component deployment and startup/attachment sequence; public API and sample checks do not establish an end-to-end mobile validation.

Validation

  • Markdown lint passes for both changed Markdown files.
  • Relative links and navigation targets verified.
  • git diff --check passes.
  • No executable samples were added, and no end-to-end mobile debugger run was performed.

Internal previews

File Preview link
docs/core/unmanaged-api/debugging/index.md Learn preview
docs/core/unmanaged-api/debugging/initialize-debugger-mobile.md Learn preview
docs/navigate/tools-diagnostics/toc.yml Learn preview

Build report

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@vitek-karas
vitek-karas requested a review from a team as a code owner September 23, 2026 14:36
Copilot AI lite review requested due to automatic review settings September 23, 2026 14:36
@dotnetrepoman dotnetrepoman Bot added this to the September 2026 milestone Sep 23, 2026

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

🟡 Changes recommended

The initialization guide has unresolved correctness and implementation details that block approval.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2 Medium severity

Open (2)
What changed in this PR

Adds documentation for initializing custom CoreCLR debuggers in .NET 11 mobile apps.

Changes:

  • Documents profiler deployment, startup configuration, debugger creation, and attachment.
  • Links the guide from debugging documentation and navigation.
File Review summary
docs/​navigate/​tools-diagnostics/​toc.yml Adds the guide to Tools/Diagnostics navigation.
docs/​core/​unmanaged-api/​debugging/​initialize-debugger-mobile.md Six moderate issues concerning platform support, version matching, API arguments, Android packaging, callback interfaces, and startup synchronization.
docs/​core/​unmanaged-api/​debugging/​index.md Links to the new mobile debugger guide.

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

Comment thread docs/core/unmanaged-api/debugging/initialize-debugger-mobile.md Outdated
Comment thread docs/core/unmanaged-api/debugging/initialize-debugger-mobile.md
@vitek-karas vitek-karas self-assigned this Sep 23, 2026
Comment thread docs/core/unmanaged-api/debugging/initialize-debugger-mobile.md Outdated
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@vitek-karas

Copy link
Copy Markdown
Member Author

I think this is ready - just needs another review.

@jkotas
jkotas merged commit 9cb96f8 into main Sep 25, 2026
12 checks passed
@jkotas
jkotas deleted the vitek-karas-mobile-debugger-initialization branch September 25, 2026 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants