Re: Memory tools documentation overhaul

2014-11-03 Thread Chris Mills
Great work Nick.

As an FYI, we also have this page about FxOS perf testing:

https://developer.mozilla.org/en-US/Apps/Build/Performance/Firefox_OS_performance_testing

I think what you’ve done is right though - no need to link all the Firefox OS 
perf stuff from the main perf page. It probably needs reorganizing before then 
anyway.

Chris Mills
   Senior tech writer || Mozilla
developer.mozilla.org || MDN
   cmi...@mozilla.com || @chrisdavidmills



> On 29 Oct 2014, at 21:19, Steve Fink  wrote:
> 
> On 10/28/2014 11:16 PM, Nicholas Nethercote wrote:
>> On Tue, Oct 28, 2014 at 9:17 PM, Nicholas Nethercote
>>  wrote:
>>> Both of these pages now just contain a single link to
>>> https://developer.mozilla.org/en-US/docs/Mozilla/Performance, which has a 
>>> new
>>> section "Memory profiling and leak detection tools" with links to pages for 
>>> all
>>> of our tools:
>>> 
>>> - about:memory
>> Relatedly, I've just added a new section to this page. It contains
>> instructions for non-experts on how to generate memory reports, e.g.
>> for attaching to a bug or writing as a comment on a website. See
>> https://developer.mozilla.org/en-US/docs/Mozilla/Performance/about:memory#How_to_generate_memory_reports
> 
> \o/
> 
> I think this is really important. Thank you for doing this! How can we
> get this included in the automated support snippets that
> support.mozilla.com seems to use?
> 
> Also, in reading through the document, I wonder if it would be useful to
> add a "File a bug" link to about:memory? Or would that be a source of
> too much noise? (I'm not sure how to make it auto-upload the memory
> report, either.)
> 
> ___
> dev-platform mailing list
> dev-platform@lists.mozilla.org
> https://lists.mozilla.org/listinfo/dev-platform

___
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform


Re: Memory tools documentation overhaul

2014-10-29 Thread Steve Fink
On 10/28/2014 11:16 PM, Nicholas Nethercote wrote:
> On Tue, Oct 28, 2014 at 9:17 PM, Nicholas Nethercote
>  wrote:
>> Both of these pages now just contain a single link to
>> https://developer.mozilla.org/en-US/docs/Mozilla/Performance, which has a new
>> section "Memory profiling and leak detection tools" with links to pages for 
>> all
>> of our tools:
>>
>> - about:memory
> Relatedly, I've just added a new section to this page. It contains
> instructions for non-experts on how to generate memory reports, e.g.
> for attaching to a bug or writing as a comment on a website. See
> https://developer.mozilla.org/en-US/docs/Mozilla/Performance/about:memory#How_to_generate_memory_reports

\o/

I think this is really important. Thank you for doing this! How can we
get this included in the automated support snippets that
support.mozilla.com seems to use?

Also, in reading through the document, I wonder if it would be useful to
add a "File a bug" link to about:memory? Or would that be a source of
too much noise? (I'm not sure how to make it auto-upload the memory
report, either.)

___
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform


Re: Memory tools documentation overhaul

2014-10-28 Thread Nicholas Nethercote
On Tue, Oct 28, 2014 at 9:17 PM, Nicholas Nethercote
 wrote:
>
> Both of these pages now just contain a single link to
> https://developer.mozilla.org/en-US/docs/Mozilla/Performance, which has a new
> section "Memory profiling and leak detection tools" with links to pages for 
> all
> of our tools:
>
> - about:memory

Relatedly, I've just added a new section to this page. It contains
instructions for non-experts on how to generate memory reports, e.g.
for attaching to a bug or writing as a comment on a website. See
https://developer.mozilla.org/en-US/docs/Mozilla/Performance/about:memory#How_to_generate_memory_reports

Nick
___
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform


Memory tools documentation overhaul

2014-10-28 Thread Nicholas Nethercote
Hi,

I've just finished a major overhaul of our documentation about memory-related
tools. We used to have two main pages on this topic:

- https://wiki.mozilla.org/Performance:Leak_Tools
- 
https://developer.mozilla.org/en-US/docs/Mozilla/Debugging/Debugging_memory_leaks

There was some overlap between the pages, the ordering was confusing, some of
the information was out-of-date, and wiki.m.o isn't the right place for this
information.

Both of these pages now just contain a single link to
https://developer.mozilla.org/en-US/docs/Mozilla/Performance, which has a new
section "Memory profiling and leak detection tools" with links to pages for all
of our tools:

- about:memory
- DMD
- areweslimyet.com
- BloatView
- Refcount tracing and balancing
- GC and CC logs
- Valgrind
- LSAN
- Apple tools
- TraceMalloc
- Leak Gauge

These pages contain cleaned-up content mostly from the two links mentioned
above. There is also a page on "Leak-hunting strategies and tips" which
contains a mish-mash of things from the two links that didn't fit neatly into
any of the tool-specific pages.

If you use any of these tools, please take a look at the docs and check them
for correctness. Some of the documentation is old and probably wrong,
especially in the "Leak-hunting strategies and tips". Please ask me if you have
any questions.

There's also this page, which is B2G specific:
https://developer.mozilla.org/en-US/Firefox_OS/Debugging/Debugging_OOMs. I've
kept that separate for now, and it's not mentioned in the "Memory profiling and
leak detection tools" section.

Thanks.

Nick
___
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform