docs: Adding a new heapdump format to the Memory Analyzer #60
Conversation
ported from the old wiki
There was a problem hiding this comment.
@jasonk000 Thanks a lot for helping out moving the Wiki content!
I like the content, that you added an intro/overview, and improved a few things!
I commented on just a few small things inline and requested changes. If you prefer, just merge it and we make smaller improvements afterwards.
One additional idea would be to link to the relevant APIs in the API reference which is part of the online eclipse help: https://help.eclipse.org/latest/topic/org.eclipse.mat.ui.help/doc/index.html
But that one requires some more effort, so we probably first simply move the docs.
| b. The Parser API makes reading the raw heap dump format pluggable. APIs conform | ||
| with Eclipse Quality Standards. | ||
|
|
||
|  |
There was a problem hiding this comment.
I like that you added the intro, and also the idea to have an image to visualise the extensions. However, the image is outdated (after 15 years :) )- at the bottom - the DTFJ parts are already in MAT, not 3d party; and I am not sure if the NW sessions parts are still around. I can try to create a new image, I'd suggest for now we simply remove it.
|
|
||
| There are some constraints on the indexes that must be met. For example, the | ||
| first outbound reference logged for each object must be to the object's class. | ||
| More information on these constraints can be found in the thread [http://www.eclipse.org/forums/index.php?t=msg&th=163200&start=0&S=86b5235a33dd47bfed74cb351e531fbf] |
There was a problem hiding this comment.
The link is not rendered properly - a URL in [] is shown. Should it be
[the thread](http://www.eclipse.org/forums/index.php?t=msg&th=163200&start=0&S=86b5235a33dd47bfed74cb351e531fbf)
?
There was a problem hiding this comment.
as in the comment in the text - I suggest we remove this image (outdated) and I try to come up with a new one
|
|
||
| ## Other references | ||
|
|
||
| - [Graduation review](http://archive.eclipse.org/projects/www/project-slides/Helios/MAT_Helios_Release.pdf) |
There was a problem hiding this comment.
I guess you added this because the image was taken from there. Should we remove it too (if we didn't use the image) or are there other useful details for the topic? I didn't spot them going quickly through the document.
- replaced the outdated image - added a reference to the online MAT API reference - fixed a wrongly formatted link Signed-off-by: Krum Tsvetkov <[email protected]>
|
@jasonk000 I allowed myself to do the proposed changes - changed the image, fixed a wrongly formatted link and added a link to the online MAT API Reference. |
|
That's great, thank you @krumts. Not sure why I had not actioned the feedback! |
ported from the old wiki
linked to #49