56 Commits

Author SHA1 Message Date
Matan Lurey
3ab49e7d9a
Delete and update stale documentation regarding engine/engine hash. (#164324)
This is intended to be merged _after_
https://github.com/flutter/flutter/pull/164317.
2025-02-27 22:49:58 +00:00
Matan Lurey
fe6c05b778
Update links to the flutter/engine repository for the monorepo. (#164328)
Just general cleanup while working on other things.
2025-02-27 21:57:59 +00:00
Matan Lurey
190d3be607
Update how to use VSCode with clangd after the monorepo merge (#163671) 2025-02-21 03:38:42 +00:00
Robert Ancell
99690cb8c7
Drop link to engine.version which is no longer checked in. (#162497)
The engine SHA is the same as the Flutter SHA since they were merged in
the monorepo.
2025-02-10 04:43:36 +00:00
Matan Lurey
9e273d5e6e
Remove scenario_app/android and rename to ios_scenario_app. (#160992)
🚫 **BLOCKED** : Do not merge until
https://github.com/flutter/flutter/issues/161261 (additional test
coverage).

---

This PR eliminates (1) `scenario_app/android`, and all references to an
Android `scenario_app`, including documentation, CI configuration, build
rules, test runner, Android-side test application, and (2), to verify
and disambiguate the remains, renames the folder `ios_scenario_app`,
which is now accurate.

It also eliminates elements that were _only_ used in the Android-side
scenario_app, such as Firebase Test Lab uploading.

I would be open to doing this in phases if we thought it was better to
do so, but given its mostly a mechanical change (and by renaming the
directory, references can be checked merely by looking for
`/\bscenario_app/`, I believe this is safe to iterate on and eventually
merge after the holidays.

## Background

As of the merged mono-repo, there is no longer a requirement for the
engine to be testable as a standalone unit.

As an example,
[`%ENGINE%/testing/scenario_app`](3762f2e973/engine/src/flutter/testing/scenario_app),
which was intended to _emulate_ the Flutter framework (and some of
`flutter_tools` tooling), load the iOS and Android embedder, and run
various "scenarios" (which ran a combination of `dart:ui` code and
Android Java/iOS Obj-C) verifying golden-file screenshots.

Instead, it is now possible to write and run _real_ (full) Flutter apps
the same way that an end-user (or our own tests) would. One such example
is
[`dev/native_driver_test`](https://github.com/flutter/flutter/tree/master/dev/integration_tests/native_driver_test),
which is a full-fledged Flutter app, which uses standard tooling (i.e.
`flutter`), to test most of the same elements that previously were only
tested in the Android version of `scenario_app`.
2025-01-28 03:43:46 +00:00
jesswrd
96e74bbb41
Add to Setup Path Example to Engine README (#162115)
Added link to direct to engine setup and a path example.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
2025-01-24 05:14:38 +00:00
Loïc Sharma
b9e86a565f
Fix link to Linux custom embedder artifacts (#161699)
This also updates the commit hashes to the latest stable Flutter engine
and addresses content that's outdated due to the monorepo merge.
2025-01-18 02:26:17 +00:00
Matan Lurey
836fd6e567
Replace fetch with gclient sync. (#161565)
Just continue to remove outdated instructions.
2025-01-14 16:55:08 +00:00
Matan Lurey
4efb64b53a
We no longer have a separate engine repo. (#161400)
Closes https://github.com/flutter/flutter/issues/161351.
2025-01-10 02:37:29 +00:00
Justin McCandless
d9342ae870
Update engine instructions for monorepo (#161184)
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
https://github.com/flutter/flutter/pull/161103 to work with the
framework changes in https://github.com/flutter/flutter/pull/159013 on
iOS compiling with `et`.
2025-01-08 21:24:53 +00:00
Brett Morgan
00ea54f1fd Flutter-GPU.md: Fix spelling (flutter/engine#57216)
[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-12-16 19:26:19 +00:00
chunhtai
0a461c4230 Update Engine-Clang-Tidy-Linter.md (flutter/engine#56708)
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

*List which issues are fixed by this PR. You must list at least one issue.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-11-19 19:16:51 +00:00
Matan Lurey
d2d49cabe7 Re-land "Remove android_jit_release_x86." (flutter/engine#56681)
Reverts flutter/engine#56634 (https://github.com/flutter/flutter/pull/159011 has merged).
2024-11-18 21:00:06 +00:00
Zachary Anderson
abb5c0696f Revert "Remove android_jit_release_x86." (flutter/engine#56634)
Reverts flutter/engine#56548

Failing roll to the framework, the tool is still looking for these
artifacts.
2024-11-15 16:14:47 -08:00
Matan Lurey
bcfae15d0e Remove android_jit_release_x86. (flutter/engine#56548)
Closes https://github.com/flutter/flutter/issues/151610.

While it appears unused in google3, cl/695899069 removes trace elements in the build configuration as well.

/cc @a-siva
2024-11-14 02:09:06 +00:00
John McDole
51d2f1623d Typo in engine_binary_hashing.md (flutter/engine#55866)
s/-R/-r
2024-10-22 09:25:20 -07:00
John McDole
35d7b1b8f3 Record notes on hashing artifacts in a monorepo (flutter/engine#55703)
aka "dude, where's my engine?"
2024-10-08 17:01:07 +00:00
Justin McCandless
d24bc5a0ef Path clarification in Setting-up-the-Engine-development-environment.md (flutter/engine#55529)
I thought that this was referring to the flutter/flutter repo, but it's actually in flutter/engine/src/flutter/bin. Updated to clarify.
2024-10-07 18:16:04 +00:00
John McDole
342fc504a2 La Grande Fusion Notes - History Editing (flutter/engine#55667)
AKA "Dude Where's My Files?"

Document the history editing that will occur during the monorepo merge.
`flutter/engine` will remain the source of truth of revisions older than
the merge.

---------

Co-authored-by: Navaron Bracke <brackenavaron@gmail.com>
2024-10-07 09:13:46 -07:00
Zuckjet
7fb25cdc23 [docs] Fix broken links in docs/ (flutter/engine#55350)
Fix broken links in docs/, specifically replaces ../ with https://github.com/flutter/flutter/blob/master/docs/

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-09-27 18:28:12 +00:00
zijiehe@
44d801da6e [fuchsia] Update fuchsia instruction in Compiling-the-engine.md (flutter/engine#55365)
Behavior of `gclient config --custom-var` got changed, modifying the instruction to edit the raw `.gclient` file to avoid unexpected gclient behavior.

Rich diff: https://github.com/flutter/engine/pull/55365/files?short_path=355a854#diff-355a854159c6f6da4e4e296d0cceb1e7e32ef26af1598aa6cdfaafbdbc656b57
Or rendered md: b375b805f9/docs/contributing/Compiling-the-engine.md (compiling-for-fuchsia)

Bug: http://b/368770157

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-09-23 18:27:04 +00:00
Brandon DeRosier
025f3839d8 Update the Impeller Scene doc (flutter/engine#55265)
Remove instructions for setting up Impeller Scene, and link to the continued Dart package.
2024-09-17 20:31:53 +00:00
davidhicks980
6674a4c33b Change "there own" to "their own" in Flutter-GPU docs (flutter/engine#54921)
Changed the word "there" to "their" in Flutter GPU doc... which I think is correct, but I could be wrong. Thanks!

- [] I listed at least one issue that this PR fixes in the description above.
- [] I added new tests to check the change I am making or feature I am adding, or the PR is [test-exempt]. See [testing the engine] for instructions on writing and running engine tests.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-09-06 16:49:18 +00:00
Gray Mackall
b01bfc77e5 Fix broken links in docs/ (flutter/engine#54815)
Fixes some links that were broken as a part of https://github.com/flutter/engine/pull/53595, because it was pointed out on discord

Specifically, replaces `../../` with `https://github.com/flutter/flutter/blob/master/docs/` in the places that `grep` surfaced it.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-27 23:14:04 +00:00
Chris Bracken
556b4ffc9c macOS: Do not archive/upload FlutterMacOS.dSYM to cloud (flutter/engine#54787)
As of the following patches, we now bundle FlutterMacOS.framework.dSYM as part of FlutterMacOS.xcframework. The dSYM is automatically copied into the release build products directory, and bundled in the .xcarchive produced by Xcode's *Product > Archive* feature which produces bundles for upload to the App Store.

* https://github.com/flutter/engine/pull/54696
* https://github.com/flutter/flutter/pull/153975

The .dSYM bundle is now available both in the uploaded .xcarchive and in the xcframework in Flutter's internal artifact cache. For developers with CI toolchains that do additional manual handling or local archiving of .dSYMs, the dSYMs no longer need to be downloaded from cloud storage as previously detailed in `docs/Crashes.md`, but can instead be copied up from the appropriate dSYM subdirectory in the framework cache:

* `flutter/bin/cache/artifacts/engine/darwin-x64-release/FlutterMacOS.xcframework`

Also adds documentation for crash symbolication on macOS.

Issue: https://github.com/flutter/flutter/issues/153879

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-26 21:35:06 +00:00
Chris Bracken
635332a0dc docs: use test: all rather than editing .ci.yaml (flutter/engine#54667)
Rather than editing `.ci.yaml` to enable the `linux_web_engine` shard, instead suggest tagging with the `test: all` label, which avoids the risk of accidentally committing an unwanted change to `.ci.yaml` and having to revert the change before landing.

This is also more future-proof against further `runIf` additions to `.ci.yaml`.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-21 19:06:49 +00:00
Chris Bracken
398d81d82d [docs] Add missing steps to Testing Presubmit Engine PRs (flutter/engine#54593)
Most framework tests perform a `flutter precache` or rely on the web SDK in some form. The Web SDK is not build in presubmit by default. As such, developers will need to manually comment out the `runIf` conditional block that prevents the web SDK from being built during presubmit, then later hope they uncomment it before landing their patch.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-16 23:15:13 +00:00
John McDole
885d9f1054 Update RBE troubleshooting (flutter/engine#54568)
Add `could not get valid Application Default Credentials token` troubleshooting
2024-08-15 19:07:05 +00:00
Brandon DeRosier
b19fe31562 Revert "[Impeller] remove scene3d support." (flutter/engine#54502)
Reverts flutter/engine#54453

Not quite ready to remove Impeller Scene yet because I'm still porting
the animation functionality. Keeping it around allows me to switch back
and forth to compare without having to recompile the engine.

Over a month ago I said something like "we can revert this a couple of
weeks from now" in one of the Impeller meetings. But for better or worse
(better, I think), I ended up spending a ton of time trying to make the
PBR good first (which doesn't exist in this C++ version).
2024-08-12 10:28:51 -07:00
Chris Bracken
c3b9f26fad iOS,docs: Update iOS symbolication docs (flutter/engine#54494)
As of flutter/flutter#153215, end user app archives now include symbols for the Flutter framework by default. So manual symbolication is no longer required.

For engine developers and others who still need to deal with manual symbols, they can now be found in the Flutter tool cache and can thus be obtained from there if required.

Issue: https://github.com/flutter/flutter/issues/116493

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-10 19:17:23 +00:00
Chris Bracken
f05c793f26 [iOS] Rename create_{full_,}ios_framework.py (flutter/engine#54493)
This renames the iOS framework creation script for consistency with the analogous macOS script.

Previously, we had two iOS framework creation scripts:
* create_ios_framework.py
* create_full_ios_framework.py

The former was unused and was deleted in https://github.com/flutter/engine/pull/54227. The addition of "full" is no longer necessary to differentiate the two.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-08-10 17:23:18 +00:00
Jonah Williams
198d1f1077 [Impeller] remove scene3d support. (flutter/engine#54453)
Now that Flutter GPU is a preview, the technical debt from having an ifdef controlled additional rendering mode can be removed.
2024-08-09 16:38:56 +00:00
Eric Seidel
07f0051638 Update pre-commit formatter to use java from repo rather than path. (flutter/engine#54450)
This removes the recently added requirement of contributors having
`java` on their path.

Also removed the mention of java being needed in setup (I don't have
java
installed and have built the engine from mac for years).

Fixes https://github.com/flutter/flutter/issues/152968
Fixes https://github.com/flutter/flutter/issues/129221
2024-08-09 08:16:08 -07:00
Brandon DeRosier
95a478b360 Update Flutter-GPU.md (flutter/engine#54366)
Remove outdated information and point to useful resources.
2024-08-06 09:38:54 -07:00
Chris Bracken
b5c7bfdb41 [docs] Delete obsolete ML guided optimisation doc (flutter/engine#54237)
In 2021, we did some experiments with ML-guided optimisations in the
engine. Ultimately, these didn't provide much benefit, and much of the
information in the documentation is now out-of-date.

For those who need it, this can always be found in the git history.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-07-31 00:04:04 +00:00
Matan Lurey
bfb6a8a100 Update Life-of-a-Flutter-Frame.md (flutter/engine#53829)
Part of https://github.com/flutter/flutter/issues/150869.
2024-07-11 16:11:46 -07:00
Matan Lurey
5a76d742ca Update Setting-up-the-Engine-development-environment.md (flutter/engine#53828)
Part of https://github.com/flutter/flutter/issues/150869.
2024-07-11 23:06:59 +00:00
Chinmay Garde
b1f84eea71 Add instructions for source debugging with Xcode when using RBE. (flutter/engine#53822) 2024-07-11 20:33:06 +00:00
Matan Lurey
af854d0c7b Copy flutter/flutter/docs/engine to flutter/engine/docs as-is (no changes) (flutter/engine#53595)
See https://github.com/flutter/flutter/issues/150869.
2024-06-26 13:35:07 -07:00
Chris Bracken
e210669748 [docs] Suggest using same Xcode version as bots (flutter/engine#52821)
Document that when using RBE, users should ensure the locally installed Xcode toolchain version matches that of the bots, otherwise they're likely to experience slow builds due to cache misses.

Ideally, we should also check the value automatically against the `sdk_version` specified in the relevant `et` build config itself.

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-05-14 21:37:09 +00:00
Chinmay Garde
e844d28955 Detail a gotcha about reproxystatus (flutter/engine#52714) 2024-05-12 21:15:27 +00:00
Zachary Anderson
a1257de605 Simplify GN pools, use in more places (flutter/engine#52721)
This PR changes from using a different GN pool for each non-compiler tool, to using one GN pool for everything.

Additionally, since we are no longer linking remotely in any configuration, this PR uses the pool for linking.

ObjC and impellerc tasks also do not (yet) run on RBE, so they are also now governed by the pool.

Needs https://github.com/flutter/buildroot/pull/856
2024-05-10 22:43:23 +00:00
Zachary Anderson
676001e40a Fix links in rbe.md (flutter/engine#52635) 2024-05-07 22:05:05 +00:00
gaaclarke
3892592ee1 Updated RBE documentation for default credentials. (flutter/engine#52530)
issue https://github.com/flutter/flutter/issues/147739

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
2024-05-02 22:03:23 +00:00
Zachary Anderson
7de6e0dcc1 Add commands to rbe.md (flutter/engine#52442) 2024-04-29 23:00:25 +00:00
Zachary Anderson
2015604d7a Add markdown docs about RBE (flutter/engine#52394) 2024-04-26 09:34:10 -07:00
Greg Spencer
87e6e728ca Add quotes around Doxygen configuration values (flutter/engine#45087)
## Description

Add quotes are the Doxygen configuration values that may have spaces, since otherwise Doxygen strips them.
2023-08-25 16:41:04 +00:00
Greg Spencer
2bcecf60c9 Change Doxyfile options to not create subdirs (flutter/engine#44855)
## Description

This turns off the Doxyfile option `CREATE_SUBDIRS` because it prevents deep link URLs from being stable. It means that thousands of files will be in the main directory, but the filesystem should be able to handle that.

I got rid of the header/footer files for doxygen (because Doxygen will generate them anyhow) and fixed where it was looking for the Flutter logo.

I also ran Doxygen on the Doxyfile template and Doxyfile and updated all the options to correspond with the latest Doxygen.
2023-08-21 17:39:06 +00:00
Greg Spencer
fc5b70b5d4 Add Doxygen doc generation for iOS, macOS, Linux, Windows, and Impeller (flutter/engine#43915)
## Description

This starts generating Doxygen docs for iOS, macOS, Linux, Windows, and Impeller. It doesn't remove the existing generation for iOS for now, until we can migrate the API docs to include these instead of those.

## Related Issues
 - https://github.com/flutter/flutter/issues/130999
 - Fixes https://github.com/flutter/flutter/issues/124833
2023-08-17 20:49:05 +00:00
Michael Goderbauer
52bb98164d Add a white background to app anatomy diagram (flutter/engine#39638) 2023-02-15 19:09:05 +00:00