[commit: ghc] wip/T13594: Edit eventlog-formats.rst to match implementation (1e9535f)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : wip/T13594
Link       : http://ghc.haskell.org/trac/ghc/changeset/1e9535fa07179c547f75aa6a7a7258e3b0cac883/ghc

>---------------------------------------------------------------

commit 1e9535fa07179c547f75aa6a7a7258e3b0cac883
Author: Mitsutoshi Aoe <maoe at foldr.in>
Date:   Mon Apr 17 06:08:25 2017 +0900

    Edit eventlog-formats.rst to match implementation
    
    * Add missing filters in EVENT_HEAP_PROF_BEGIN and reorder them
    * EVENT_HEAP_PROF_SAMPLE_COST_CENTRE isn't used in retainer profiling
    * Modify EVENT_HEAP_PROF_SAMPLE_STRING's format
    * Biography break-down isn't implemented


>---------------------------------------------------------------

1e9535fa07179c547f75aa6a7a7258e3b0cac883
 docs/users_guide/eventlog-formats.rst | 32 +++++++++-----------------------
 1 file changed, 9 insertions(+), 23 deletions(-)

diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst
index 74a62f2..8d53f92 100644
--- a/docs/users_guide/eventlog-formats.rst
+++ b/docs/users_guide/eventlog-formats.rst
@@ -38,11 +38,13 @@ A single fixed-width event emitted during program start-up describing the sample
       * ``SAMPLE_TYPE_MODULE`` (output from ``-hm``)
       * ``SAMPLE_TYPE_TYPE_DESCR`` (output from ``-hy``)
       * ``SAMPLE_TYPE_BIOGRAPHY`` (output from ``-hb``)
-   * ``String``: Cost centre filter
-   * ``String``: Closure description filter
-   * ``String``: Retainer filter
    * ``String``: Module filter
+   * ``String``: Closure description filter
    * ``String``: Type description filter
+   * ``String``: Cost centre filter
+   * ``String``: Cost centre stack filter
+   * ``String``: Retainer filter
+   * ``String``: Biography filter
 
 Cost center definitions
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -81,9 +83,8 @@ Cost-center break-down
 
 A variable-length packet encoding a heap profile sample broken down by,
  * cost-center (``-hc``)
- * retainer (``-hr``)
 
- * ``EVENT_HEAP_PROF_SAMPLE``
+ * ``EVENT_HEAP_PROF_SAMPLE_COST_CENTRE``
    * ``Word8``: Profile ID
    * ``Word64``: heap residency in bytes
    * ``Word8``: stack depth
@@ -98,22 +99,7 @@ A variable-length event encoding a heap sample broken down by,
  * closure description (``-hd``)
  * module (``-hm``)
 
- * ``EVENT_HEAP_PROF_SAMPLE``
+ * ``EVENT_HEAP_PROF_SAMPLE_STRING``
    * ``Word8``: Profile ID
-   * The event shall contain packed pairs of,
-     * ``String``: type description
-     * ``Word64``: heap residency in bytes
-
-
-Biography break-down
-^^^^^^^^^^^^^^^^^^^^
-
-A fixed-length event encoding a biography heap sample.
-
- * ``EVENT_HEAP_PROF_SAMPLE``
-   * ``Word8``: Profile ID
-   * ``Word64``: Void
-   * ``Word64``: Lag
-   * ``Word64``: Use
-   * ``Word64``: Inherent use
-   * ``Word64``: Drag
+   * ``Word64``: heap residency in bytes
+   * ``String``: type or closure description, or module name