Skip to content

fix(flutter): update Windows native crash support docs for SDK v9.0.0 #17206

@sentry-junior

Description

@sentry-junior

Summary

The Desktop Limitations section in the Flutter features docs incorrectly states that native crashes are not supported on Windows. As of sentry_flutter 9.0.0, this is no longer true and the docs need to be updated to reflect current behavior.

Background

The current docs/platforms/dart/guides/flutter/features/index.mdx contains:

Native crashes are not supported on Windows.

This was accurate for SDK v8.x, where native crash reporting on Windows was disabled by default (and explicitly disabled in v8.11.2 due to toolchain compatibility issues). As of v9.0.0 (sentry-dart PR #2791), crashpad is enabled by default on Windows x64/x86 and breakpad on ARM64.

The troubleshooting page (troubleshooting/#issues-with-native-crashes-on-linux-andor-windows) already reflects the current behavior accurately, creating a contradiction between the two pages.

Scope

  • File: docs/platforms/dart/guides/flutter/features/index.mdx
  • In scope: Update the Windows native crash limitation bullet to reflect v9.0.0 behavior; note opt-in path for SDK < 9.0.0 users
  • Out of scope: Changes to the troubleshooting page (already accurate)

Implementation

Replace:

Native crashes are not supported on Windows.

With something like:

Native crashes are supported on Windows x64/x86 via crashpad and on Windows ARM64 via breakpad (SDK ≥ 9.0.0). On SDK versions prior to 9.0.0, native crash reporting on Windows was disabled by default and could be opted in by setting `SENTRY_NATIVE_BACKEND=crashpad`.

The Release Health limitation bullet remains accurate and should be kept.

Dependencies

Action taken on behalf of Simon Zhong.

Metadata

Metadata

Assignees

Labels

No labels
No labels
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions