From 0200f63ed36dfc247a0b32b1acb14ac827034e8f Mon Sep 17 00:00:00 2001 From: Polina Cherkasova Date: Sun, 28 Jan 2024 12:51:53 -0800 Subject: [PATCH 1/2] - --- .vscode/settings.json | 4 +++- doc/USAGE.md | 6 +++--- doc/leak_tracking/DETECT.md | 2 ++ 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 087dd682..5231129c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -12,8 +12,10 @@ "pkgs", "polina", "polinach", + "pubspec", "snapshotting", "sublist", - "unawaited" + "unawaited", + "Upvote" ], } diff --git a/doc/USAGE.md b/doc/USAGE.md index 47af0efa..32d4e93f 100644 --- a/doc/USAGE.md +++ b/doc/USAGE.md @@ -6,7 +6,7 @@ See other information on memory debugging [here](../README.md). Dart and Flutter applications can be configured to automatically trigger memory usage events and, in case of memory overuse, to save memory heap snapshots to hard drive. -The snapshots can be later analysed in DevTools. +The snapshots can be later analyzed in DevTools. https://user-images.githubusercontent.com/12115586/234953319-6f864d25-9854-4126-b4d6-8e114b9045ff.mov @@ -19,9 +19,9 @@ See [example](../examples/autosnapshotting/). We recommend to have auto-snapshotting off by default, with possibility to enable it via command line arguments in case of reported memory issues. -## Analyse snapshots +## Analyze snapshots -Use [CLI](https://github.com/dart-lang/sdk/tree/main/runtime/tools/heapsnapshot#cli-usage) to analyse the collected snapshots. +Use [CLI](https://github.com/dart-lang/sdk/tree/main/runtime/tools/heapsnapshot#cli-usage) to analyze the collected snapshots. Upvote [the issue](https://github.com/dart-lang/leak_tracker/issues/125) to enable graphical snapshot analysis with DevTools. diff --git a/doc/leak_tracking/DETECT.md b/doc/leak_tracking/DETECT.md index a4a78d57..2c2017c7 100644 --- a/doc/leak_tracking/DETECT.md +++ b/doc/leak_tracking/DETECT.md @@ -5,6 +5,8 @@ The text below is under construction. # Detect Memory Leaks +The documentation below works for flutter SDK 3.18.0 and upper. + This page describes how to auto-detect certain types of memory leaks. Read more about leak tracking in [overview](OVERVIEW.md). From 813d434ca732b58f4360d94639ca2b25e3418d8e Mon Sep 17 00:00:00 2001 From: Polina Cherkasova Date: Tue, 30 Jan 2024 11:29:50 -0800 Subject: [PATCH 2/2] Update DETECT.md --- doc/leak_tracking/DETECT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/leak_tracking/DETECT.md b/doc/leak_tracking/DETECT.md index 2c2017c7..4d5643e9 100644 --- a/doc/leak_tracking/DETECT.md +++ b/doc/leak_tracking/DETECT.md @@ -5,7 +5,7 @@ The text below is under construction. # Detect Memory Leaks -The documentation below works for flutter SDK 3.18.0 and upper. +The documentation below is valid for Flutter SDKs >= 3.18.0. This page describes how to auto-detect certain types of memory leaks. Read more about leak tracking in [overview](OVERVIEW.md).