New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 801006 link

Starred by 1 user

Issue metadata

Status: Started
Owner:
Cc:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Task



Sign in to add a comment

Cleanup documentation for memory tools/efforts

Project Member Reported by ajwong@chromium.org, Jan 11 2018

Issue description

There's stuff scattered in google docs, a docs/memory-infra directory a docs/memory directory, README.mds that are colocated with code, code that doesn't have a README.md, and bunches of tribal knowledge.

Gonna try to bring some order to that right now.
 
Project Member

Comment 1 by bugdroid1@chromium.org, Jan 11 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/34b06ef57c1fe56f76a7e4e6d7f1f2f1df9ae22b

commit 34b06ef57c1fe56f76a7e4e6d7f1f2f1df9ae22b
Author: Albert J. Wong <ajwong@chromium.org>
Date: Thu Jan 11 18:57:26 2018

docs/memory: create describing tools that exist

First in a set of changes to the memory directory. The idea is to consolidate
some overview documentation for techniques and tools used, even if the
documentation does nothing more than name the tool or provide keywords for
a dev to start doing searches on.

The idea is to get some of the tribal knowledge down on paper.

Overall, the docs will focus on helping answer problems as opposed to
describing how things work.

Bug: 801006
Change-Id: I93c72cabfafdbd103eda64aa94791a23885663ae
Reviewed-on: https://chromium-review.googlesource.com/861197
Reviewed-by: Erik Chen <erikchen@chromium.org>
Commit-Queue: Albert J. Wong <ajwong@chromium.org>
Cr-Commit-Position: refs/heads/master@{#528691}
[add] https://crrev.com/34b06ef57c1fe56f76a7e4e6d7f1f2f1df9ae22b/docs/memory/tools.md

Project Member

Comment 2 by bugdroid1@chromium.org, Jan 16 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/2db98ee2600c882c32303171a0bf9e451d1cba1d

commit 2db98ee2600c882c32303171a0bf9e451d1cba1d
Author: Albert J. Wong <ajwong@chromium.org>
Date: Tue Jan 16 23:17:07 2018

docs/memory: Describe diff_heap_profiler.py and y so many tools!

Bug: 801006
Change-Id: Ib50cf8a6e4678322d1e2b24e95a9e18b1b0073ae
Reviewed-on: https://chromium-review.googlesource.com/862704
Commit-Queue: Albert J. Wong <ajwong@chromium.org>
Reviewed-by: Maria Khomenko <mariakhomenko@chromium.org>
Reviewed-by: Erik Chen <erikchen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#529516}
[modify] https://crrev.com/2db98ee2600c882c32303171a0bf9e451d1cba1d/docs/memory/tools.md

Project Member

Comment 3 by bugdroid1@chromium.org, Jan 17 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/3948511dd9cf0e8c38b702e1e707181479f146c3

commit 3948511dd9cf0e8c38b702e1e707181479f146c3
Author: Albert J. Wong <ajwong@chromium.org>
Date: Wed Jan 17 23:07:51 2018

docs/memory: Describe memory-infra and heap profiling

This overlaps some of the documentation in docs/memory-infra.
The objective of this documentation is to provide a higher-level summary
of the features with a description about the types of memory questions
that they can answer as opposed to a detailed explanation of all the
attributes.

Bug: 801006
Change-Id: Idbbc2815b1be8721c7a0af195e32e0792fa31215
Reviewed-on: https://chromium-review.googlesource.com/869854
Reviewed-by: Maria Khomenko <mariakhomenko@chromium.org>
Reviewed-by: Erik Chen <erikchen@chromium.org>
Commit-Queue: Albert J. Wong <ajwong@chromium.org>
Cr-Commit-Position: refs/heads/master@{#529940}
[modify] https://crrev.com/3948511dd9cf0e8c38b702e1e707181479f146c3/docs/memory/tools.md

Project Member

Comment 4 by bugdroid1@chromium.org, Jan 18 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/17417476f2f670439a458c9f69b8209ed3678252

commit 17417476f2f670439a458c9f69b8209ed3678252
Author: Albert J. Wong <ajwong@chromium.org>
Date: Thu Jan 18 23:50:23 2018

docs/memory: Describe OOPHP configuration.

Also clean up some of the flag descriptions.

Bug: 801006
Change-Id: I0641961e896db4af7f92171fa8bc78080c9e6f28
Reviewed-on: https://chromium-review.googlesource.com/874815
Commit-Queue: Albert J. Wong <ajwong@chromium.org>
Reviewed-by: Erik Chen <erikchen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#530347}
[modify] https://crrev.com/17417476f2f670439a458c9f69b8209ed3678252/chrome/browser/flag_descriptions.cc
[modify] https://crrev.com/17417476f2f670439a458c9f69b8209ed3678252/docs/memory/tools.md

Owner: erikc...@chromium.org
Project Member

Comment 6 by bugdroid1@chromium.org, Feb 26 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/8f908e2790fa892a2b8dededc42da6075008317a

commit 8f908e2790fa892a2b8dededc42da6075008317a
Author: Erik Chen <erikchen@chromium.org>
Date: Mon Feb 26 16:06:58 2018

Add documentation for filing a memory bug on desktop.

Bug: 801006
Change-Id: If04968c66cf755cff0b892a5230d77ca6808a2a9
Reviewed-on: https://chromium-review.googlesource.com/935721
Reviewed-by: Primiano Tucci <primiano@chromium.org>
Commit-Queue: Erik Chen <erikchen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#539149}
[modify] https://crrev.com/8f908e2790fa892a2b8dededc42da6075008317a/docs/memory/README.md
[add] https://crrev.com/8f908e2790fa892a2b8dededc42da6075008317a/docs/memory/filing_memory_bugs.md

Project Member

Comment 7 by bugdroid1@chromium.org, Mar 2 2018

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/e0525355e931b7d5f81d7c358d96dcff5c90353e

commit e0525355e931b7d5f81d7c358d96dcff5c90353e
Author: Erik Chen <erikchen@chromium.org>
Date: Fri Mar 02 16:23:20 2018

Add documentation for debugging memory issues and additional terminology.

Bug: 801006
Change-Id: Ic75538c44814c912ab623af4959f74cd081000f7
Reviewed-on: https://chromium-review.googlesource.com/939668
Commit-Queue: Erik Chen <erikchen@chromium.org>
Reviewed-by: Primiano Tucci <primiano@chromium.org>
Cr-Commit-Position: refs/heads/master@{#540529}
[modify] https://crrev.com/e0525355e931b7d5f81d7c358d96dcff5c90353e/docs/memory-infra/README.md
[modify] https://crrev.com/e0525355e931b7d5f81d7c358d96dcff5c90353e/docs/memory/README.md
[add] https://crrev.com/e0525355e931b7d5f81d7c358d96dcff5c90353e/docs/memory/debugging_memory_issues.md
[modify] https://crrev.com/e0525355e931b7d5f81d7c358d96dcff5c90353e/docs/memory/key_concepts.md

Sign in to add a comment