32 Commits

Author SHA1 Message Date
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
Michael Goderbauer
2693ea12a5 Add app anatomy diagram (flutter/engine#39628) 2023-02-14 20:34:00 +00:00
Gary Qian
3f63f97728 Add more diagrams for deferred components docs, fix alignment of existing one (flutter/engine#26209) 2021-05-17 17:54:01 -07:00
Gary Qian
d7032b3d19 Add diagrams for Wiki (flutter/engine#26172) 2021-05-17 02:14:39 -07:00
Chinmay Garde
4d78ea99f6 Minor tweaks to the Doxygen theme. (flutter/engine#11576) 2019-09-03 22:27:14 -04:00
gaaclarke
3e1981ede2 Added Doxyfile. (flutter/engine#9632)
Added Doxyfile.
2019-07-01 14:32:38 -07:00
Chris Bracken
5ee33d78cf Minor update to README (flutter/engine#5003)
* Adds a docs directory with an architecture diagram from @chinmaygarde.
* Excludes the flutter/docs directory from license script.
2018-04-13 15:46:54 -07:00