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

Add and fix more tooling redirects #10767

Merged
merged 2 commits into from
Jun 20, 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
12 changes: 10 additions & 2 deletions firebase.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,9 @@
{ "source": "/testing/best-practices", "destination": "/perf/best-practices", "type": 301 },
{ "source": "/testing/integration-tests/migration", "destination": "/release/breaking-changes/flutter-driver-migration", "type": 301 },
{ "source": "/testing/ui-performance", "destination": "/perf/ui-performance", "type": 301 },
{ "source": "/tools/devtools", "destination": "/tools/devtools/overview", "type": 301 },
{ "source": "/tools/devtools/code-size", "destination": "/tools/devtools/app-size", "type": 301 },
{ "source": "/tools/devtools/codeSize", "destination": "/tools/devtools/app-size", "type": 301 },
{ "source": "/tools/devtools/overview", "destination": "/tools/devtools", "type": 301 },
{ "source": "/tools/devtools/timeline", "destination": "/tools/devtools/performance", "type": 301 },
{ "source": "/tools/ide", "destination": "/tools/android-studio", "type": 301 },
{ "source": "/tools/ide/android-studio", "destination": "/tools/android-studio", "type": 301 },
Expand Down Expand Up @@ -647,16 +647,20 @@
{ "source": "/to/build-modes", "destination": "/testing/build-modes", "type": 301 },
{ "source": "/to/china-setup", "destination": "/community/china", "type": 301 },
{ "source": "/to/crash-reporting", "destination": "/reference/crash-reporting", "type": 301 },
{ "source": "/to/debug-mode", "destination": "/testing/build-modes#debug", "type": 301 },
{ "source": "/to/debug-render-layer", "destination": "/testing/code-debugging#print-the-render-tree", "type": 301 },
{ "source": "/to/deep-link-tool", "destination": "/ui/navigation/deep-linking", "type": 301 },
{ "source": "/to/deep-linking", "destination": "/ui/navigation/deep-linking", "type": 301 },
{ "source": "/to/develop-packages", "destination": "/packages-and-plugins/developing-packages", "type": 301 },
{ "source": "/to/develop-plugins", "destination": "/packages-and-plugins/developing-packages#plugin", "type": 301 },
{ "source": "/to/editor-setup", "destination": "/get-started/editor", "type": 301 },
{ "source": "/to/federated-plugins", "destination": "/packages-and-plugins/developing-packages#federated-plugins", "type": 301 },
{ "source": "/to/flutter-fix", "destination": "/tools/flutter-fix", "type": 301 },
{ "source": "/to/flutter-test-docs", "destination": "https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html", "type": 301 },
{ "source": "/to/font-from-package", "destination": "/cookbook/design/package-fonts#use", "type": 301 },
{ "source": "/to/gesture-disambiguation", "destination": "/ui/interactivity/gestures#gesture-disambiguation", "type": 301 },
{ "source": "/to/gestures", "destination": "/ui/interactivity/gestures", "type": 301 },
{ "source": "/to/handle-errors", "destination": "/testing/errors", "type": 301 },
{ "source": "/to/hot-reload", "destination": "/tools/hot-reload", "type": 301 },
{ "source": "/to/impeller", "destination": "/perf/impeller", "type": 301 },
{ "source": "/to/install", "destination": "/get-started/install", "type": 301 },
Expand All @@ -678,18 +682,21 @@
{ "source": "/to/macos-ffi", "destination": "/platform-integration/macos/c-interop", "type": 301 },
{ "source": "/to/macos-ios-setup", "destination": "/get-started/install/macos/mobile-ios", "type": 301 },
{ "source": "/to/macos-minimum-target", "destination": "/deployment/ios#review-xcode-project-settings", "type": 301 },
{ "source": "/to/minimize-layout-passes", "destination": "/perf/best-practices#minimize-layout-passes-caused-by-intrinsic-operations", "type": 301 },
{ "source": "/to/performance-overlay", "destination": "/perf/ui-performance#performance-overlay", "type": 301 },
{ "source": "/to/platform-channels", "destination": "/platform-integration/platform-channels", "type": 301 },
{ "source": "/to/platform-plugins", "destination": "/packages-and-plugins/using-packages", "type": 301 },
{ "source": "/to/previous-releases", "destination": "/release/archive", "type": 301 },
{ "source": "/to/profile-mode", "destination": "/perf/ui-performance#run-in-profile-mode", "type": 301 },
{ "source": "/to/profile-mode", "destination": "/testing/build-modes#profile", "type": 301 },
{ "source": "/to/pub-system-cache", "destination": "https://dart.dev/tools/pub/glossary#system-cache", "type": 301 },
{ "source": "/to/pubspec-plugin-platforms", "destination": "/packages-and-plugins/developing-packages#plugin-platforms", "type": 301 },
{ "source": "/to/recommend-const", "destination": "/perf/best-practices#control-build-cost", "type": 301 },
{ "source": "/to/reference-keystore", "destination": "/deployment/android#reference-the-keystore-from-the-app", "type": 301 },
{ "source": "/to/release-mode", "destination": "/testing/build-modes#release", "type": 301 },
{ "source": "/to/report-bugs", "destination": "/resources/bug-reports", "type": 301 },
{ "source": "/to/resolution-aware-images", "destination": "/ui/assets/assets-and-images#resolution-aware", "type": 301 },
{ "source": "/to/review-gradle-config", "destination": "/deployment/android#review-the-gradle-build-configuration", "type": 301 },
{ "source": "/to/save-layer-perf", "destination": "/perf/best-practices#use-savelayer-thoughtfully", "type": 301 },
{ "source": "/to/state-management-sample", "destination": "/data-and-backend/state-mgmt/simple", "type": 301 },
{ "source": "/to/track-widget-creation", "destination": "/tools/devtools/inspector#track-widget-creation", "type": 301 },
{ "source": "/to/troubleshoot-devices", "destination": "/get-started/install", "type": 301 },
Expand All @@ -699,6 +706,7 @@
{ "source": "/to/update-macos-path", "destination": "/get-started/install/macos/mobile-ios?tab=download#add-flutter-to-your-path", "type": 301 },
{ "source": "/to/update-windows-path", "destination": "/get-started/install/windows/mobile?tab=download#update-your-windows-path-variable", "type": 301 },
{ "source": "/to/use-mirror-site", "destination": "/community/china#configure-your-machine-to-use-a-mirror-site", "type": 301 },
{ "source": "/to/use-profile-mode", "destination": "/perf/ui-performance#run-in-profile-mode", "type": 301 },
{ "source": "/to/wasm", "destination": "/platform-integration/web/wasm", "type": 301 },
{ "source": "/to/web-bootstrapping", "destination": "/platform-integration/web/initialization", "type": 301 },
{ "source": "/to/web-images", "destination": "/platform-integration/web/web-images", "type": 301 },
Expand Down
2 changes: 1 addition & 1 deletion src/_data/sidenav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@
permalink: /tools/devtools
children:
- title: Overview
permalink: /tools/devtools/overview
permalink: /tools/devtools
- title: Run from Android Studio & IntelliJ
permalink: /tools/devtools/android-studio
- title: Run from VS Code
Expand Down
2 changes: 1 addition & 1 deletion src/_includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<a class="dropdown-item {% if route contains '/get-started/install' %} active{% endif %}"
href="/get-started/install">Install Flutter</a>
<a class="dropdown-item {% if route contains '/tools/devtools' %} active{% endif %}"
href="/tools/devtools/overview">DevTools</a>
href="/tools/devtools">DevTools</a>
<a class="dropdown-item {% if route contains '/cookbook' %} active{% endif %}"
href="/cookbook">Cookbook</a>
<a class="dropdown-item {% if route contains '/codelabs' %} active{% endif %}"
Expand Down
4 changes: 2 additions & 2 deletions src/content/get-started/codelab-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -1119,11 +1119,11 @@ Dart DevTools, or Flutter animations, see the following:
[Building a form with validation]: /cookbook/forms/validation
[Chrome browser]: https://www.google.com/chrome/?brand=CHBD&gclid=CjwKCAiAws7uBRAkEiwAMlbZjlVMZCxJDGAHjoSpoI_3z_HczSbgbMka5c9Z521R89cDoBM3zAluJRoCdCEQAvD_BwE&gclsrc=aw.ds
[create a new Flutter project]: /get-started/test-drive
[Dart DevTools]: /tools/devtools/overview
[Dart DevTools]: /tools/devtools
[DartPad]: {{site.dartpad}}
[DevTools command line]: /tools/devtools/cli
[DevTools documentation]: /tools/devtools
[DevTools installed]: /tools/devtools/overview#start
[DevTools installed]: /tools/devtools#start
[DartPad troubleshooting page]: {{site.dart-site}}/tools/dartpad/troubleshoot
[`didUpdateWidget`]: {{site.api}}/flutter/widgets/State/didUpdateWidget.html
[editor]: /get-started/editor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2555,7 +2555,7 @@ For more information on using the Firebase Cloud Messaging API, see the
[Cupertino widgets]: /ui/widgets/cupertino
[`devicePixelRatio`]: {{site.api}}/flutter/dart-ui/FlutterView/devicePixelRatio.html
[developing packages and plugins]: /packages-and-plugins/developing-packages
[DevTools]: /tools/devtools/overview
[DevTools]: /tools/devtools
[existing plugin]: {{site.pub}}/flutter
[`google_mobile_ads`]: {{site.pub}}/packages/google_mobile_ads
[`firebase_analytics`]: {{site.pub}}/packages/firebase_analytics
Expand Down
2 changes: 1 addition & 1 deletion src/content/platform-integration/web/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Not currently.
[Creating responsive apps]: /ui/adaptive-responsive
[Debugging]: /tools/devtools/debugger
[file an issue]: {{site.repo.flutter}}/issues/new?title=[web]:+%3Cdescribe+issue+here%3E&labels=%E2%98%B8+platform-web&body=Describe+your+issue+and+include+the+command+you%27re+running,+flutter_web%20version,+browser+version
[Flutter DevTools]: /tools/devtools/overview
[Flutter DevTools]: /tools/devtools
[Generating event timeline]: {{site.developers}}/web/tools/chrome-devtools/evaluate-performance/performance-reference
[`http`]: {{site.pub}}/packages/http
[`iframe`]: https://html.com/tags/iframe/
Expand Down
2 changes: 1 addition & 1 deletion src/content/release/archive-whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ You might also check out [Introducing Dart 3][].
[Material Widget Catalog]: /ui/widgets/material
[canvasKitVariant runtime configuration]: /platform-integration/web/initialization
[Android Java Gradle migration]: /release/breaking-changes/android-java-gradle-migration-guide
[DevTools]: /tools/devtools/overview
[DevTools]: /tools/devtools
[WebAssembly support]: /platform-integration/web/wasm
[adding iOS app extensions]: /platform-integration/ios/app-extensions
[testing Flutter plugins]: /testing/testing-plugins
Expand Down
2 changes: 1 addition & 1 deletion src/content/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ called Dart DevTools). For more information, see
[Debugging with Flutter][] and the [Flutter DevTools][] docs.

[Debugging with Flutter]: /testing/debugging
[Flutter DevTools]: /tools/devtools/overview
[Flutter DevTools]: /tools/devtools

### Does Flutter come with a dependency injection framework?

Expand Down
2 changes: 1 addition & 1 deletion src/content/tools/devtools/app-size.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,6 @@ to reduce an app's size are also discussed.
[Generating size files]: #generating-size-files
[Analysis tab]: #analysis-tab
[Diff tab]: #diff-tab
[launch instructions]: /tools/devtools/overview#install-devtools
[launch instructions]: /tools/devtools#start
[App Size Documentation]: /perf/app-size#breaking-down-the-size
[app-size-tutorial]: {{site.medium}}/@fluttergems/mastering-dart-flutter-devtools-app-size-tool-part-3-of-8-9be6e9ec42a2
103 changes: 100 additions & 3 deletions src/content/tools/devtools/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,102 @@
---
layout: toc
title: DevTools
description: Content covering the Dart and Flutter DevTools.
title: Flutter and Dart DevTools
description: How to use Flutter DevTools with Flutter.
---

## What is DevTools?

DevTools is a suite of performance and debugging tools
for Dart and Flutter.
_Flutter DevTools_ and _Dart DevTools_ refer to the
same set of tools.

![Dart DevTools Screens](/assets/images/docs/tools/devtools/dart-devtools.gif){:width="100%"}

For a video introduction to DevTools, check out
the following deep dive and use-case walkthrough:

<iframe width="560" height="315" src="{{site.yt.embed}}/_EYk-E29edo" title="Dive in to Flutter DevTools" {{site.yt.set}}></iframe>

[Dive in to DevTools]({{site.yt.watch}}?v=_EYk-E29edo)

## What can I do with DevTools?

Here are some of the things you can do with DevTools:

* Inspect the UI layout and state of a Flutter app.
* Diagnose UI jank performance issues in a Flutter app.
* CPU profiling for a Flutter or Dart app.
* Network profiling for a Flutter app.
* Source-level debugging of a Flutter or Dart app.
* Debug memory issues in a Flutter or Dart
command-line app.
* View general log and diagnostics information
about a running Flutter or Dart
command-line app.
* Analyze code and app size.
* Validate deep links in your Android app.

We expect you to use DevTools in conjunction with
your existing IDE or command-line based development workflow.

<a id="how-do-i-install-devtools"></a>
<a id="install-devtools"></a>

## How to launch DevTools {:#start}

See the [VS Code][], [Android Studio/IntelliJ][], or
[command line][] pages for instructions on how to launch DevTools.

## Troubleshooting some standard issues

**Question**: My app looks janky or stutters.
How do I fix it?

**Answer**: Performance issues can cause [UI frames][]
to be janky and/or slow down some operations.

1. To detect which code impacts concrete late frames,
start at [Performance > Timeline][].
2. To learn which code takes the most CPU time in
the background, use the [CPU profiler][].

For more information, check out the
[Performance][] page.

**Question**: I see a lot of garbage collection (GC) events occurring.
Is this a problem?

**Answer**: Frequent GC events might display on
the DevTools > Memory > Memory chart. In most cases,
it's not a problem.

If your app has frequent background activity with some idle time,
Flutter might use that opportunity to collect the created objects
without performance impact.

[CPU profiler]: /tools/devtools/cpu-profiler
[Performance]: /perf
[Performance > Timeline]: /tools/devtools/performance#timeline-events-tab
[UI frames]: /perf/ui-performance

## Providing feedback

Please give DevTools a try, provide feedback, and file issues
in the [DevTools issue tracker][]. Thanks!

## Other resources

For more information on debugging and profiling
Flutter apps, see the [Debugging][] page and,
in particular, its list of [other resources][].

For more information on using DevTools with
Dart command-line apps, see the
[DevTools documentation on dart.dev]({{site.dart-site}}/tools/dart-devtools).

[Android Studio/IntelliJ]: /tools/devtools/android-studio
[VS Code]: /tools/devtools/vscode
[command line]: /tools/devtools/cli
[DevTools issue tracker]: {{site.github}}/flutter/devtools/issues
[Debugging]: /testing/debugging
[Other resources]: /testing/debugging#other-resources
6 changes: 5 additions & 1 deletion src/content/tools/devtools/memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This page is up to date for DevTools 2.23.0.
:::

For information on how to locate DevTools screens in different IDEs,
check out the [DevTools overview](/tools/devtools/overview).
check out the [DevTools overview](/tools/devtools).

To better understand the insights found on this page,
the first section explains how Dart manages memory.
Expand Down Expand Up @@ -383,6 +383,8 @@ The quantities plotted on the y-axis are as follows:
[frog]: https://dartfrog.vgv.dev/
[heroku]: {{site.yt.watch}}?v=nkTUMVNelXA

<a id="profile-tab" aria-hidden="true"></a>

### Profile Memory tab

Use the **Profile Memory** tab to see current memory
Expand Down Expand Up @@ -410,6 +412,8 @@ to narrow the data:
For a deeper analysis in Google Sheets
or other tools, download the data in CSV format.

<a id="trace-tab" aria-hidden="true"></a>

### Trace Instances tab

Use the **Trace Instances** tab to investigate what methods
Expand Down
102 changes: 0 additions & 102 deletions src/content/tools/devtools/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The 2.10.0 release of the Dart and Flutter DevTools
includes the following changes among other general improvements.
To learn more about DevTools, check out the
[DevTools overview](https://docs.flutter.dev/tools/devtools/overview).
[DevTools overview](https://docs.flutter.dev/tools/devtools).

## Flutter inspector updates

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The 2.11.2 release of the Dart and Flutter DevTools
includes the following changes among other general improvements.
To learn more about DevTools, check out the
[DevTools overview](https://docs.flutter.dev/tools/devtools/overview).
[DevTools overview](https://docs.flutter.dev/tools/devtools).

## General updates

Expand Down
Loading
Loading