Update docs to debug the Android embedder #166170
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gaaclarke
reviewed
Mar 28, 2025
| 1. Build the local engine with the `--no-stripped` flag. | ||
| 2. Decide on a Flutter app that you with to debug and run it with `flutter run` and the local engine flags. i.e.: `--debug --local-engine-src-path path/to/my/engine/src --local-engine=android_debug_unopt_arm64` | ||
| 1. Build an unoptimized local engine. i.e. `et build -c host_debug_unopt_arm64 && et build -c android_debug_unopt_arm64`. | ||
| 2. Decide on a Flutter app that you with to debug and run it with `flutter run` and the local engine flags. i.e.: `--debug --local-engine-src-path path/to/my/engine/src --local-engine=android_debug_unopt_arm64`. |
There was a problem hiding this comment.
This step is building with flutter build apk
| 5. To attach the debugger, use `Run > Attach Debugger to Android Process`. For "Use Android Debugger Settings from" choose `[Use default settings]`, and for "Debug Type" choose `Native Only`. | ||
| <img src="https://github.com/user-attachments/assets/a79dc331-6540-4c03-b880-58d1552a7f75" width="600" /> | ||
|
|
||
| 7. Once attached, you can use Android Studio to open local engine C++ source files and set breakpoints. You can set Symbolic Breakpoints, i.e. Symbol name `impeller::ContextVK::ContectVK`. | ||
|
|
There was a problem hiding this comment.
Add a note about potentially having to edit lldb's source map for RBE builds.
There was a problem hiding this comment.
Done. Rearranged this to share instructions with the Xcode section:
https://github.com/flutter/flutter/blob/42fe52039f4e90643c60aee669887b7dc23204ca/engine/src/flutter/docs/Debugging-the-engine.md
gmackall
approved these changes
Mar 28, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 3, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 3, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 3, 2025
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
Apr 3, 2025
Roll Flutter from a0b1b3253416 to 02f13c37841f (37 revisions) flutter/flutter@a0b1b32...02f13c3 2025-04-03 [email protected] Roll Packages from 07496eb to 4a36dc6 (3 revisions) (flutter/flutter#166542) 2025-04-03 [email protected] Roll Skia from b67e53719e78 to 5f65df75febd (2 revisions) (flutter/flutter#166538) 2025-04-03 [email protected] Update docs to debug the Android embedder (flutter/flutter#166170) 2025-04-03 [email protected] Roll Dart SDK from 72562ca93bb5 to d174ec16c3ea (1 revision) (flutter/flutter#166525) 2025-04-03 [email protected] [macOS] Implement merged UI and platform thread (flutter/flutter#162883) 2025-04-03 [email protected] Roll Skia from f91412f5d89d to b67e53719e78 (1 revision) (flutter/flutter#166527) 2025-04-03 [email protected] Roll Packages from 125c117 to 07496eb (31 revisions) (flutter/flutter#166457) 2025-04-03 [email protected] Roll Skia from 2be12bc2668b to f91412f5d89d (2 revisions) (flutter/flutter#166517) 2025-04-03 [email protected] Roll Dart SDK from 2a1a13cc3a91 to 72562ca93bb5 (2 revisions) (flutter/flutter#166514) 2025-04-03 [email protected] [native_assets] Roll dependencies (flutter/flutter#166282) 2025-04-03 [email protected] Fix read only TextField focus traversal on macOS (flutter/flutter#166056) 2025-04-03 [email protected] Roll Skia from c106d7831592 to 2be12bc2668b (1 revision) (flutter/flutter#166509) 2025-04-03 [email protected] Roll Fuchsia Linux SDK from v7PGvypiiWLO8PbsZ... to vYisSsIgqw0mqFRVJ... (flutter/flutter#166508) 2025-04-03 [email protected] Roll Dart SDK from b8b4076b1237 to 2a1a13cc3a91 (1 revision) (flutter/flutter#166504) 2025-04-03 [email protected] Roll Skia from 75a0ec473181 to c106d7831592 (1 revision) (flutter/flutter#166499) 2025-04-03 [email protected] Migrate to Theme.brightnessOf method (flutter/flutter#163950) 2025-04-03 [email protected] Fix: Range slider show overlay for both thumbs on hovering one (flutter/flutter#165393) 2025-04-03 [email protected] Deprecate ExpansionTileController (flutter/flutter#166368) 2025-04-03 [email protected] Add styling parameters in `PopupMenuDivider` (flutter/flutter#164790) 2025-04-03 [email protected] Fix ISSUE_TEMPLATE Ordering: `10 < 9`, but `10 > 09` (flutter/flutter#166455) 2025-04-03 [email protected] Skip flaking scheduler test (flutter/flutter#166471) 2025-04-02 [email protected] Roll pub packages (flutter/flutter#166043) 2025-04-02 [email protected] [a11y] add SemanticsValidationResult (flutter/flutter#165935) 2025-04-02 [email protected] Remove unnecessary cache busting mechanism in hot restart (flutter/flutter#166295) 2025-04-02 [email protected] Roll Skia from 52cbb917fffd to 75a0ec473181 (21 revisions) (flutter/flutter#166484) 2025-04-02 [email protected] Started pixel aligning hairlines (flutter/flutter#166351) 2025-04-02 [email protected] Adds semantics role and adjust semantics for navigation bar (flutter/flutter#162467) 2025-04-02 [email protected] Reland "[skwasm] Dynamic Threading" (flutter/flutter#166454) 2025-04-02 [email protected] [dart:ui] Add `Path.addRSuperellipse` (flutter/flutter#166045) 2025-04-02 [email protected] Fix: Hero animation for page transition (flutter/flutter#164469) 2025-04-02 [email protected] Fix: DelegateTransition for cupertino sheet route (flutter/flutter#164675) 2025-04-02 [email protected] Roll Fuchsia Test Scripts from AEdsljKmUiPk92Wvv... to FZdRtNwH7jmADecj6... (flutter/flutter#166383) 2025-04-02 [email protected] [Impeller] cache for text shadows. (flutter/flutter#166228) 2025-04-02 [email protected] Convert `AppPluginLoaderPlugin` to Kotlin, and add `NativePluginLoaderReflectionBridge` to expose it in Kotlin (flutter/flutter#166027) 2025-04-02 [email protected] Roll Dart SDK from 4e1f02bc704f to b8b4076b1237 (7 revisions) (flutter/flutter#166474) 2025-04-02 [email protected] Update Roadmap (flutter/flutter#166332) 2025-04-02 [email protected] Update `CODEOWNERS` (flutter/flutter#166444) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...
CodixNinja
pushed a commit
to CodixNinja/packages
that referenced
this pull request
May 15, 2025
Roll Flutter from a0b1b3253416 to 02f13c37841f (37 revisions) flutter/flutter@a0b1b32...02f13c3 2025-04-03 [email protected] Roll Packages from d10d5af to 95f8e65 (3 revisions) (flutter/flutter#166542) 2025-04-03 [email protected] Roll Skia from b67e53719e78 to 5f65df75febd (2 revisions) (flutter/flutter#166538) 2025-04-03 [email protected] Update docs to debug the Android embedder (flutter/flutter#166170) 2025-04-03 [email protected] Roll Dart SDK from 72562ca93bb5 to d174ec16c3ea (1 revision) (flutter/flutter#166525) 2025-04-03 [email protected] [macOS] Implement merged UI and platform thread (flutter/flutter#162883) 2025-04-03 [email protected] Roll Skia from f91412f5d89d to b67e53719e78 (1 revision) (flutter/flutter#166527) 2025-04-03 [email protected] Roll Packages from 0d5d57b to d10d5af (31 revisions) (flutter/flutter#166457) 2025-04-03 [email protected] Roll Skia from 2be12bc2668b to f91412f5d89d (2 revisions) (flutter/flutter#166517) 2025-04-03 [email protected] Roll Dart SDK from 2a1a13cc3a91 to 72562ca93bb5 (2 revisions) (flutter/flutter#166514) 2025-04-03 [email protected] [native_assets] Roll dependencies (flutter/flutter#166282) 2025-04-03 [email protected] Fix read only TextField focus traversal on macOS (flutter/flutter#166056) 2025-04-03 [email protected] Roll Skia from c106d7831592 to 2be12bc2668b (1 revision) (flutter/flutter#166509) 2025-04-03 [email protected] Roll Fuchsia Linux SDK from v7PGvypiiWLO8PbsZ... to vYisSsIgqw0mqFRVJ... (flutter/flutter#166508) 2025-04-03 [email protected] Roll Dart SDK from b8b4076b1237 to 2a1a13cc3a91 (1 revision) (flutter/flutter#166504) 2025-04-03 [email protected] Roll Skia from 75a0ec473181 to c106d7831592 (1 revision) (flutter/flutter#166499) 2025-04-03 [email protected] Migrate to Theme.brightnessOf method (flutter/flutter#163950) 2025-04-03 [email protected] Fix: Range slider show overlay for both thumbs on hovering one (flutter/flutter#165393) 2025-04-03 [email protected] Deprecate ExpansionTileController (flutter/flutter#166368) 2025-04-03 [email protected] Add styling parameters in `PopupMenuDivider` (flutter/flutter#164790) 2025-04-03 [email protected] Fix ISSUE_TEMPLATE Ordering: `10 < 9`, but `10 > 09` (flutter/flutter#166455) 2025-04-03 [email protected] Skip flaking scheduler test (flutter/flutter#166471) 2025-04-02 [email protected] Roll pub packages (flutter/flutter#166043) 2025-04-02 [email protected] [a11y] add SemanticsValidationResult (flutter/flutter#165935) 2025-04-02 [email protected] Remove unnecessary cache busting mechanism in hot restart (flutter/flutter#166295) 2025-04-02 [email protected] Roll Skia from 52cbb917fffd to 75a0ec473181 (21 revisions) (flutter/flutter#166484) 2025-04-02 [email protected] Started pixel aligning hairlines (flutter/flutter#166351) 2025-04-02 [email protected] Adds semantics role and adjust semantics for navigation bar (flutter/flutter#162467) 2025-04-02 [email protected] Reland "[skwasm] Dynamic Threading" (flutter/flutter#166454) 2025-04-02 [email protected] [dart:ui] Add `Path.addRSuperellipse` (flutter/flutter#166045) 2025-04-02 [email protected] Fix: Hero animation for page transition (flutter/flutter#164469) 2025-04-02 [email protected] Fix: DelegateTransition for cupertino sheet route (flutter/flutter#164675) 2025-04-02 [email protected] Roll Fuchsia Test Scripts from AEdsljKmUiPk92Wvv... to FZdRtNwH7jmADecj6... (flutter/flutter#166383) 2025-04-02 [email protected] [Impeller] cache for text shadows. (flutter/flutter#166228) 2025-04-02 [email protected] Convert `AppPluginLoaderPlugin` to Kotlin, and add `NativePluginLoaderReflectionBridge` to expose it in Kotlin (flutter/flutter#166027) 2025-04-02 [email protected] Roll Dart SDK from 4e1f02bc704f to b8b4076b1237 (7 revisions) (flutter/flutter#166474) 2025-04-02 [email protected] Update Roadmap (flutter/flutter#166332) 2025-04-02 [email protected] Update `CODEOWNERS` (flutter/flutter#166444) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose ...
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 20, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 20, 2025
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update Android embedder debugging instructions.
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.