diff options
Diffstat (limited to 'docs/users_guide')
| -rw-r--r-- | docs/users_guide/9.2.1-notes.rst | 5 | ||||
| -rw-r--r-- | docs/users_guide/profiling.rst | 17 |
2 files changed, 4 insertions, 18 deletions
diff --git a/docs/users_guide/9.2.1-notes.rst b/docs/users_guide/9.2.1-notes.rst index 06134387f3..9812279849 100644 --- a/docs/users_guide/9.2.1-notes.rst +++ b/docs/users_guide/9.2.1-notes.rst @@ -114,10 +114,13 @@ Runtime system Moreover, we now correctly account for the size of the array, meaning that space lost to fragmentation is no longer counted as live data. - - The :rts-flag:`-h` flag has been deprecated, use either :rts-flag:`-hc` or :rts-flag:`-hT` explicitly, as appropriate. +- The ``-xt`` RTS flag has been removed. Now STACK and TSO closures are always + included in heap profiles. Tooling can choose to filter out these closure types + if necessary. + ``ghc-prim`` library ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 2463654837..1eddcb7160 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -886,20 +886,6 @@ There are three more options which relate to heap profiling: profiles are always sampled with the frequency of the RTS clock. See :ref:`prof-time-options` for changing that. -.. rts-flag:: -xt - - Include the memory occupied by threads in a heap profile. Each - thread takes up a small area for its thread state in addition to the - space allocated for its stack (stacks normally start small and then - grow as necessary). - - This includes the main thread, so using :rts-flag:`-xt` is a good way to see - how much stack space the program is using. - - Memory occupied by threads and their stacks is labelled as “TSO” and - “STACK” respectively when displaying the profile by closure - description or type description. - .. rts-flag:: -L ⟨num⟩ Sets the maximum length of a cost-centre stack name in a heap @@ -1049,9 +1035,6 @@ reasons for this: ⟨factor⟩` option. Also add the size of the allocation area (see :rts-flag:`-A ⟨size⟩`). -- The stack isn't counted in the heap profile by default. See the - RTS :rts-flag:`-xt` option. - - The program text itself, the C stack, any non-heap data (e.g. data allocated by foreign libraries, and data allocated by the RTS), and ``mmap()``\'d memory are not counted in the heap profile. |