Tong Mu
97b5264fcc
Migrate in-comment links of the flutter/engine repository to the flutter/flutter repository ( #166790 )
...
This PR migrates almost all in-comment links that points to the main
branch of flutter/engine repository to the flutter/flutter repository,
ensuring that such links are always up to date.
I've manually verified that all links are valid. There are a few cases
where the migration is not so trivial and I had to look up for the
updated location or line number, but I'm pretty sure the new value is
correct.
The only place that I don't know how to migrate is two links in
[Upgrading-pre-1.12-Android-projects.md](https://github.com/flutter/flutter/blob/master/docs/platforms/android/Upgrading-pre-1.12-Android-projects.md )
pointing to
`https://github.com/flutter/engine/blob/main/shell/platform/android/io/flutter/app/FlutterActivity.java `,
which I guess no longer exists.
There are still many links that point to a specific branch or revision
of the engine repo. I don't think we need to migrate these links, since
they're probably not meant to be kept up to date.
## Pre-launch Checklist
- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [ ] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [ ] I updated/added relevant documentation (doc comments with `///`).
- [ ] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [ ] 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-04-10 15:58:23 +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
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
Matan Lurey
836fd6e567
Replace fetch with gclient sync. ( #161565 )
...
Just continue to remove outdated instructions.
2025-01-14 16:55:08 +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
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
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)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
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
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
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
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
