Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in docs/ #54815

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/contributing/Compiling-the-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Run the following steps, from the `src` directory created in [Setting up the Eng
> 💡 **TIP**: When developing on a Mac with ARM (M CPU), prefer `host_debug_unopt_arm64`.
>
> You can continue to use `host_debug_unopt` (required for Intel Macs), but the engine will be run under Rosetta
> which may be slower. See [Developing with Flutter on Apple Silicon](../../platforms/desktop/macos/Developing-with-Flutter-on-Apple-Silicon.md)
> which may be slower. See [Developing with Flutter on Apple Silicon](https://github.com/flutter/flutter/blob/master/docs/platforms/desktop/macos/Developing-with-Flutter-on-Apple-Silicon.md)
> for more information.

4. Build your executables
Expand All @@ -80,11 +80,11 @@ If you're going to be debugging crashes in the engine, make sure you add
`android/AndroidManifest.xml` file for the Flutter app you are using
to test the engine.

See [The flutter tool](../../tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
See [The flutter tool](https://github.com/flutter/flutter/blob/master/docs/tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
You will typically use the `android_debug_unopt` build to debug the engine on a device, and
`android_debug_unopt_x64` to debug in on a simulator. Modifying dart sources in the engine will
require adding a `dependency_override` section in you app's `pubspec.yaml` as detailed
[here](../../tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).
[here](https://github.com/flutter/flutter/blob/master/docs/tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).

Note that if you use particular android or ios engine build, you will need to have corresponding
host build available next to it: if you use `android_debug_unopt`, you should have built `host_debug_unopt`,
Expand Down Expand Up @@ -133,11 +133,11 @@ Run the following steps, from the `src` directory created in the steps above:

5. `ninja -C out/ios_debug_unopt && ninja -C out/host_debug_unopt` to build all artifacts (use `out/ios_debug_sim_unopt` for Simulator).

See [The flutter tool](../../tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
See [The flutter tool](https://github.com/flutter/flutter/blob/master/docs/tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
You will typically use the `ios_debug_unopt` build to debug the engine on a device, and
`ios_debug_sim_unopt` to debug in on a simulator. Modifying dart sources in the engine will
require adding a `dependency_override` section in you app's `pubspec.yaml` as detailed
[here](../../tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).
[here](https://github.com/flutter/flutter/blob/master/docs/tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).

See also [instructions for debugging the engine in a Flutter app in Xcode](../Debugging-the-engine.md#debugging-ios-builds-with-xcode).

Expand All @@ -155,10 +155,10 @@ These steps build the desktop embedding, and the engine used by `flutter test` o
4. `ninja -C out/host_debug_unopt` to build a desktop unoptimized binary.
* If you skipped `--unoptimized`, use `ninja -C out/host_debug` instead.

See [The flutter tool](../../tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
See [The flutter tool](https://github.com/flutter/flutter/blob/master/docs/tool/README.md) for instructions on how to use the `flutter` tool with a local engine.
You will typically use the `host_debug_unopt` build in this setup. Modifying dart sources in the engine will
require adding a `dependency_override` section in you app's `pubspec.yaml` as detailed
[here](../../tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).
[here](https://github.com/flutter/flutter/blob/master/docs/tool/README.md#using-a-locally-built-engine-with-the-flutter-tool).


## Compiling for Windows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ gclient sync
## Next steps:

* [Compiling the engine](Compiling-the-engine.md) explains how to actually get builds, now that you have the code.
* [The flutter tool](../../tool/README.md) has a section explaining how to use custom engine builds.
* [Signing commits](../../contributing/Signing-commits.md), to configure your environment to securely sign your commits.
* [The flutter tool](https://github.com/flutter/flutter/blob/master/docs/tool/README.md) has a section explaining how to use custom engine builds.
* [Signing commits](https://github.com/flutter/flutter/blob/master/docs/contributing/Signing-commits.md), to configure your environment to securely sign your commits.

## Editor autocomplete support

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/Testing-the-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ Xcode and hit CMD+U.
Dart unit tests are executed during pre-submit on our CI system when submitting
PRs to the `flutter/engine` repository.

_See also: [Flutter Test Fonts](../../contributing/testing/Flutter-Test-Fonts.md)_
_See also: [Flutter Test Fonts](https://github.com/flutter/flutter/blob/master/docs/contributing/testing/Flutter-Test-Fonts.md)_

### Framework tests

Expand Down