Add documentation on heap-profile file format.
GHC docs currently lack of .hp file format specification. This trends people to make incorrect assumptions on file format. For example authors of hp2any-core package attemt to use haskell read function to read job title, but actually profiler outputs unescaped values between quotation marks, so approach fails when quoted string contains backslashes. I suggest to add more documentation on file format, especially how numeric values, strings and dates represented.
Trac metadata
| Trac field | Value |
|---|---|
| Version | 7.4.2 |
| Type | FeatureRequest |
| TypeOfFailure | OtherFailure |
| Priority | normal |
| Resolution | Unresolved |
| Component | Documentation |
| Test case | |
| Differential revisions | |
| BlockedBy | |
| Related | |
| Blocking | |
| CC | |
| Operating system | |
| Architecture |