Update engine instructions for monorepo by justinmc · Pull Request #161184 · flutter/flutter

justinmc · 2025-01-06T21:03:16Z

I was struggling to get the engine to compile now that it's under the flutter/flutter monorepo, and I noticed that the wiki docs have not been updated since the monorepo migration completed. This PR attempts to update them to give a process that works with the new setup.

I've gone ahead and updated all of the links in the "Engine repo" section of the wiki to point to the flutter/flutter copies of these docs since they were previously pointing to the flutter/engine copies.

I tested these instructions by following them myself and successfully getting the engine changes in #161103 to work with the framework changes in #159013 on iOS compiling with et.

matanlurey

LGTM with one change requested.

matanlurey · 2025-01-06T21:08:06Z

engine/src/flutter/docs/contributing/Compiling-the-engine.md

 ### Compiling everything that matters on Linux

-The following script will update all the builds that matter if you're developing on Linux and testing on Android and created the `.gclient` file in `~/dev/engine`:
+The following script will update all the builds that matter if you're developing on Linux and testing on Android if your `.gclient` file is located at `~/dev/flutter/engine/.gclient`:


I think the script has to be in ~/dev/flutter/.gclient actually.

Good catch, fixed!

@matanlurey

As pointed out by @matanlurey in review.

engine/src/flutter/docs/contributing/Compiling-the-engine.md

engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md

Just point to the instructions in the framework setup doc.

jtmcdole · 2025-01-06T22:46:45Z

engine/src/flutter/docs/contributing/Compiling-the-engine.md

+1. `git pull upstream master` to update the Flutter repo.

-2. `gclient sync` to update dependencies.
+2. `gclient sync -D` to update dependencies.


I think this is run in the "root" folder and not "engine/src", but then again doesn't gclient find the root for you?

jtmcdole · 2025-01-06T22:50:39Z

engine/src/flutter/docs/contributing/Compiling-the-engine.md

+Run the following steps, from the `engine/src` directory:

-1. `git pull upstream main` in `src/flutter` to update the Flutter Engine repo.
+1. `git pull upstream master` to update the Flutter repo.


I know this is old documentation, but why do we have different git instructions than from above? Isn't it always going to be the same:

(assuming you are on origin/master)

git fetch upstream

git rebase upstream/main

gclient sync -D

et build

flutter/docs/contributing/Tree-hygiene.md

Lines 140 to 153 in 5a23a2a

## Using git

Assuming your environment has been configured according to the instructions in

[Setting up the Engine development environment](../engine/contributing/Setting-up-the-Engine-development-environment.md),

[Setting up the Framework development environment](Setting-up-the-Framework-development-environment.md), or

[Setting up the Packages development environment](../ecosystem/contributing/Setting-up-the-Packages-development-environment.md),

follow these steps to start working on a patch:

* `git fetch upstream`

* `git checkout upstream/main -b name_of_your_branch`

* `flutter update-packages`

* Hack away.

* `git commit -a -m "<your informative commit message>"`

* `git push origin name_of_your_branch`

jtmcdole · 2025-01-06T22:52:52Z

i'm not going to block this because any improvement is for the best. I think we need oen unified "here's how you check out the code" and then one that's specific to "here's how you gclient sync to get deps and et build".

Instead of repeating how to update the code in every section

justinmc · 2025-01-07T00:24:53Z

@jtmcdole I've updated this to have a central "updating" section that all the other sections refer to, instead of repeating the steps each time. Good call.

Maybe after the archiving of flutter/engine is finished we should revisit all of these docs overall. For now I hope this PR will help people that might otherwise struggle developing the engine in the monorepo.

jtmcdole · 2025-01-07T17:19:16Z

Thanks - I didn't mean for the comment to be blocking. LGTM

Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) flutter/flutter@4b23b81...864d4f5 2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997) 2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998) 2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996) 2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999) 2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000) 2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349) 2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391) 2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392) 2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400) 2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344) 2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404) 2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401) 2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379) 2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246) 2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396) 2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525) 2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394) 2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307) 2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331) 2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276) 2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389) 2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196) 2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567) 2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354) 2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278) 2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347) 2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637) 2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199) 2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342) 2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339) 2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184) 2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287) 2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275) 2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270) 2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109) 2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263) 2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326) 2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978) 2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032) 2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318) 2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277) 2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292) ...

I was struggling to get the engine to compile now that it's under the flutter/flutter monorepo, and I noticed that the wiki docs have not been updated since the monorepo migration completed. This PR attempts to update them to give a process that works with the new setup. I've gone ahead and updated all of the links in the "Engine repo" section of [the wiki](https://github.com/flutter/flutter/wiki) to point to the flutter/flutter copies of these docs since they were previously pointing to the flutter/engine copies. I tested these instructions by following them myself and successfully getting the engine changes in flutter#161103 to work with the framework changes in flutter#159013 on iOS compiling with `et`.

Roll Flutter from 4b23b81 to 864d4f5 (50 revisions) flutter/flutter@4b23b81...864d4f5 2025-01-10 [email protected] Mark complex_layout_scroll_perf_macos__timeline_summary unflaky (flutter/flutter#160997) 2025-01-10 [email protected] Mark hello_world_macos__compile unflaky (flutter/flutter#160998) 2025-01-10 [email protected] Mark animated_complex_opacity_perf_macos__e2e_summary unflaky (flutter/flutter#160996) 2025-01-10 [email protected] Mark integration_ui_test_test_macos unflaky (flutter/flutter#160999) 2025-01-10 [email protected] Mark hot_mode_dev_cycle_macos_target__benchmark unflaky (flutter/flutter#161000) 2025-01-10 [email protected] Add a virtual-display (VD) platform view test, and refactor tests a bit. (flutter/flutter#161349) 2025-01-10 [email protected] Remove `CIRRUS_TASK_NAME` from what I can tell, is always omitted on `LUCI` (flutter/flutter#161391) 2025-01-10 [email protected] Replace the always omitted `CPU` environment variable with `numberOfProcessors`. (flutter/flutter#161392) 2025-01-10 [email protected] We no longer have a separate engine repo. (flutter/flutter#161400) 2025-01-10 [email protected] Update Style-guide-for-Flutter-repo.md (flutter/flutter#161344) 2025-01-09 [email protected] integration_test: Add gitignore of golden image (flutter/flutter#161404) 2025-01-09 [email protected] Fix link to engine docs in CONTRIBUTING.md (flutter/flutter#161401) 2025-01-09 [email protected] Roll Packages from 3fc6b7a to 6554751 (11 revisions) (flutter/flutter#161379) 2025-01-09 [email protected] Add `mouseCursor` parameter to `ReorderableListView` (flutter/flutter#160246) 2025-01-09 [email protected] Remove Cirrus CI from Flutter goldens. (flutter/flutter#161396) 2025-01-09 [email protected] remove`useMaterial3: true,` in from the template (flutter/flutter#160525) 2025-01-09 [email protected] Remove `accept_android_sdk_licenses.sh`, which appears unused. (flutter/flutter#161388) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-312.0.dev (flutter/flutter#161394) 2025-01-09 [email protected] Marks Linux analyzer_benchmark to be flaky (flutter/flutter#161307) 2025-01-09 [email protected] [Impeller] fix scaling of trampoline import of GLES textures into Vulkan. (flutter/flutter#161331) 2025-01-09 [email protected] Support DDC library bundle format and remove support for DDC module format (flutter/flutter#161276) 2025-01-09 [email protected] Remove seemingly stale web Cirrus and "Web Installer" instructions (flutter/flutter#161389) 2025-01-09 [email protected] Proposal to deprecate `webGoldenComparator`. (flutter/flutter#161196) 2025-01-09 [email protected] `ImplicitlyAnimatedWidgetState` code cleanup (flutter/flutter#160567) 2025-01-09 [email protected] Exclude `*texture*` as matching for `a: text input` (flutter/flutter#161354) 2025-01-09 [email protected] [Impeller] add opt in flag for SurfaceControl testing. (flutter/flutter#161353) 2025-01-09 [email protected] Roll Dart to Version 3.7.0-307.0.dev (flutter/flutter#161278) 2025-01-09 [email protected] remove formatter from snippet tool (flutter/flutter#161347) 2025-01-09 [email protected] Refactor keyboard manager tests (flutter/flutter#160637) 2025-01-09 [email protected] [flutter_tools] ignore viewpost ime and samsung spam messages. (flutter/flutter#161199) 2025-01-09 [email protected] Revert "[SwiftPM] Add separate feature flag for the app migration (#158897)" (flutter/flutter#161342) 2025-01-09 [email protected] git ignore .ccls-cache (flutter/flutter#161340) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[SwiftPM] Turn on by default (#161275)" (flutter/flutter#161339) 2025-01-08 [email protected] Update engine instructions for monorepo (flutter/flutter#161184) 2025-01-08 [email protected] [Impeller] re-enable Adreno 630 (flutter/flutter#161287) 2025-01-08 [email protected] [SwiftPM] Turn on by default (flutter/flutter#161275) 2025-01-08 [email protected] Make the encoding of a `YamlNode` to a `String` more explicit. (flutter/flutter#161270) 2025-01-08 [email protected] Normalize the translation column of the color matrix. (flutter/flutter#161109) 2025-01-08 [email protected] Rename `native_driver` to `android_{driver_extensions|engine_test}` (flutter/flutter#161263) 2025-01-08 [email protected] [Impeller] reland: fix porterduff shader and handle optimized out texture binding in GLES backend. (flutter/flutter#161326) 2025-01-08 [email protected] Updating AVD Dependency for Android 28 Emulator (flutter/flutter#160978) 2025-01-08 [email protected] Adds onHover and onLongPress to IconButton widget (flutter/flutter#160032) 2025-01-08 [email protected] Marks Linux linux_desktop_impeller to be unflaky (flutter/flutter#161302) 2025-01-08 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Impeller] porter duff workarounds for Adreno GPU. (#161273)" (flutter/flutter#161318) 2025-01-08 [email protected] Revert "fixed keyboardDismissBehavior on scroll without a drag" (flutter/flutter#161277) 2025-01-08 [email protected] Revert "use uuid from package:uuid instead of from package:usage" (flutter/flutter#161292) ...

Applied diff from flutter/engine#57264

41a81d7

github-actions bot added the engine flutter/engine related. See also e: labels. label Jan 6, 2025

justinmc mentioned this pull request Jan 6, 2025

Update engine instructions for monorepo flutter/engine#57264

Closed

justinmc requested a review from matanlurey January 6, 2025 21:06

justinmc marked this pull request as ready for review January 6, 2025 21:06

matanlurey approved these changes Jan 6, 2025

View reviewed changes

Clarifying location *must* be as-given

5f21d87

As pointed out by @matanlurey in review.

jtmcdole reviewed Jan 6, 2025

View reviewed changes

engine/src/flutter/docs/contributing/Compiling-the-engine.md Outdated Show resolved Hide resolved

jtmcdole reviewed Jan 6, 2025

View reviewed changes

engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md Outdated Show resolved Hide resolved

justinmc added 2 commits January 6, 2025 13:35

No seriously though, use et.

f639f95

Correction on checking out source

ce61534

Just point to the instructions in the framework setup doc.

justinmc requested a review from jtmcdole January 6, 2025 21:44

justinmc mentioned this pull request Jan 6, 2025

[ios][secure_paste]Show context items based on items sent from framework flutter/engine#56362

Closed

8 tasks

jtmcdole approved these changes Jan 6, 2025

View reviewed changes

Central "Updating" section

718c554

Instead of repeating how to update the code in every section

Merge branch 'master' into engine-monorepo-docs

7f66e57

justinmc added this pull request to the merge queue Jan 8, 2025

Merged via the queue into flutter:master with commit d9342ae Jan 8, 2025

justinmc deleted the engine-monorepo-docs branch January 8, 2025 22:20

justinmc mentioned this pull request Jan 8, 2025

[Android] Implement setting content sensitivity on Android #158473

Closed

9 tasks

engine-flutter-autoroll mentioned this pull request Jan 9, 2025

Roll Flutter from 4b23b8182888 to 5f77df9269ac (24 revisions) flutter/packages#8400

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

c451b00

engine-flutter-autoroll mentioned this pull request Jan 9, 2025

Roll Flutter from 4b23b8182888 to 6bda88b61b6c (25 revisions) flutter/packages#8401

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

72cbdd8

engine-flutter-autoroll mentioned this pull request Jan 9, 2025

Roll Flutter from 4b23b8182888 to e0b424b7cd4f (26 revisions) flutter/packages#8402

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

fb1880a

engine-flutter-autoroll mentioned this pull request Jan 10, 2025

Roll Flutter from 4b23b8182888 to 864d4f59dde0 (50 revisions) flutter/packages#8407

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

e6632be

engine-flutter-autoroll mentioned this pull request Jan 10, 2025

Roll Flutter from 4b23b8182888 to 864d4f59dde0 (50 revisions) flutter/packages#8408

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 10, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

cb3bef8

Piinks mentioned this pull request Jan 11, 2025

Flutter Notable Commits - 2025 #161460

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

6b8c084

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

b00b5fb

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

5231feb

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

f9ff5f4

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025

d9342ae Update engine instructions for monorepo (flutter/flutter#161184)

a2d8dd0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update engine instructions for monorepo#161184

Update engine instructions for monorepo#161184
justinmc merged 6 commits intoflutter:masterfrom
justinmc:engine-monorepo-docs

justinmc commented Jan 6, 2025 •

edited

Loading

Uh oh!

matanlurey left a comment

Uh oh!

matanlurey Jan 6, 2025

Uh oh!

justinmc Jan 6, 2025

Uh oh!

Uh oh!

Uh oh!

jtmcdole Jan 6, 2025

Uh oh!

jtmcdole Jan 6, 2025

Uh oh!

jtmcdole commented Jan 6, 2025

Uh oh!

justinmc commented Jan 7, 2025

Uh oh!

jtmcdole commented Jan 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	## Using git

	Assuming your environment has been configured according to the instructions in
	[Setting up the Engine development environment](../engine/contributing/Setting-up-the-Engine-development-environment.md),
	[Setting up the Framework development environment](Setting-up-the-Framework-development-environment.md), or
	[Setting up the Packages development environment](../ecosystem/contributing/Setting-up-the-Packages-development-environment.md),
	follow these steps to start working on a patch:

	* `git fetch upstream`
	* `git checkout upstream/main -b name_of_your_branch`
	* `flutter update-packages`
	* Hack away.
	* `git commit -a -m "<your informative commit message>"`
	* `git push origin name_of_your_branch`

Conversation

justinmc commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matanlurey left a comment

Choose a reason for hiding this comment

Uh oh!

matanlurey Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

justinmc Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jtmcdole Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

jtmcdole Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

jtmcdole commented Jan 6, 2025

Uh oh!

justinmc commented Jan 7, 2025

Uh oh!

jtmcdole commented Jan 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

justinmc commented Jan 6, 2025 •

edited

Loading