Skip to content

Update CONCEPTS.md #163

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update CONCEPTS.md #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions doc/CONCEPTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The text below is under construction.
This page describes leak tracking concepts.
See other information on memory leaks [here](../README.md).

Before reading about leak tracking, understand [Dart memory concepts](https://docs.flutter.dev/development/tools/devtools/memory#basic-memory-concepts).
Before reading about leak-tracking, understand [Dart memory concepts](https://docs.flutter.dev/development/tools/devtools/memory#basic-memory-concepts).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'leak' and 'tracking' are two separate words here.


## Addressed leak types

Expand Down Expand Up @@ -50,7 +50,7 @@ the following types of leaks:
### Disposed, but not GCed, without path (not-GCed-without-path)

- **Definition**: an object
was disposed and not GCed when expected, but retaining path
was disposed and not GCed when expected, but the retaining path
is not detected; that means that the object will be most likely GCed in
the next GC cycle,
and the leak will convert to [GCed-late](#gced-late) leak.
Expand All @@ -62,7 +62,7 @@ something is wrong with the tool.

## Culprits and victims

If you have a set of not-GCed objects, some of them (victims)
If you have a set of non-GCed objects, some of them (victims)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not-GCed is a leak type explained above.

might not be GC-ed because they are held by others (culprits).
Normally, to fix the leaks, you need to only fix the culprits.

Expand Down