Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
runtime: current heapdump format is undocumented #15169
runtime/debug.WriteHeapDump's godocs link to https://golang.org/s/go15heapdump, but that describes a file format that starts with "go1.5 heap dump\n".
Currently, runtime.dumphdr is "go1.7 heap dump\n". Before 30f93f0, it was "go1.6 heap dump\n". So that's at least two revisions to the heap dump file format that are undocumented.
Relevant because https://go-review.googlesource.com/#/c/21647/1 might change the heap dump format again.
We need to stop documenting the heap dump in a wiki and document it in the main go repo in the same commit where the format changes.
Ideally with, say, tests. And ideally end-to-end tests writing then reading the heap dump that would break if the heapdump format changes. (which empirically it does, regularly)