Skip to content

docs(apple): add troubleshooting guide for arm64e linker errors#18769

Merged
NinjaLikesCheez merged 2 commits into
masterfrom
docs/apple-arm64e-troubleshooting
Jul 21, 2026
Merged

docs(apple): add troubleshooting guide for arm64e linker errors#18769
NinjaLikesCheez merged 2 commits into
masterfrom
docs/apple-arm64e-troubleshooting

Conversation

@NinjaLikesCheez

@NinjaLikesCheez NinjaLikesCheez commented Jul 20, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

  • Adding a recently discovered bug in Xcode that could affect customers - although we've not seen any issues yet.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel

vercel Bot commented Jul 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview Jul 21, 2026 6:18am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jul 21, 2026 6:18am

Request Review

@codeowner-assignment
codeowner-assignment Bot requested a review from a team July 20, 2026 14:05

## Linker Errors with SPM Dependencies in Xcode on arm64e

This issue only affects projects that integrate Sentry via Swift Package Manager using the <PlatformLink to="/install/swift-package-manager/">`SentrySPM` (compile from source)</PlatformLink> product and build for arm64e. The pre-built binary products (`Sentry`, `Sentry-Dynamic`) are not affected.

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.

Bug: The troubleshooting guide for the arm64e linker error incorrectly omits the SentryObjC SPM product as an affected package.
Severity: MEDIUM

Suggested Fix

Update the documentation to clarify that the arm64e linker issue affects all compile-from-source Swift Package Manager products, including both SentrySPM and SentryObjC.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/apple/common/troubleshooting/index.mdx#L225

Potential issue: The troubleshooting guide for an `arm64e` linker error incorrectly
states that the issue only affects projects using the `SentrySPM` product. This is
inaccurate because the `SentryObjC` Swift Package Manager product, which also compiles
from source, is equally affected by the same Xcode linker bug. A developer using
`SentryObjC` who encounters this build error would read the guide and mistakenly
conclude the provided workaround does not apply to them, leaving their build issue
unresolved.

Did we get this right? 👍 / 👎 to inform future reviews.


## Linker Errors with SPM Dependencies in Xcode on arm64e

This issue only affects projects that integrate Sentry via Swift Package Manager using the <PlatformLink to="/install/swift-package-manager/">`SentrySPM` (compile from source)</PlatformLink> product and build for arm64e. The pre-built binary products (`Sentry`, `Sentry-Dynamic`) are not affected.

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.

We need to clarify that this only affects using SPM in Xcode UI, and not xcodebuild nor swift build.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed in ec13929 - let me know if that's clear enough.

@philprime philprime 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.

LGTM

@NinjaLikesCheez
NinjaLikesCheez merged commit 668265c into master Jul 21, 2026
23 checks passed
@NinjaLikesCheez
NinjaLikesCheez deleted the docs/apple-arm64e-troubleshooting branch July 21, 2026 08:01
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.

2 participants