Skip to content

Commit 0ec03a7

Browse files
author
doyougnu
committed
prelim: add how to debug chapter
1 parent f0a7dd9 commit 0ec03a7

File tree

7 files changed

+578
-277
lines changed

7 files changed

+578
-277
lines changed

Diff for: index.rst

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ by `Input Output Global <https://iohk.io/>`_.
2626
Release History
2727
---------------
2828

29+
* February, 2024
30+
31+
* :ref:`How to Debug <How To Debug chapter>` first draft finished.
32+
2933
* March/April, 2023
3034

3135
* :ref:`Klister Case Study <klister case study>` first draft finished.

Diff for: src/Measurement_Observation/Binary_Profiling/valgrind.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. Valgrind
1+
.. _Valgrind Chapter:
22

33
:lightgrey:`Valgrind`
44
=====================

Diff for: src/Measurement_Observation/Haskell_Profiling/eventlog.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ define and track their own events using the base functions `traceEvent
5555
When should I use Eventlog
5656
--------------------------
5757

58-
Eventlog is most useful when you need to :ref:`Characterize the Problem
59-
<characterize-the-problem>`. It yields runtime information on the specific
60-
sub-system the program relies on. Thus, it allows you to drill down into the
61-
behavior of the garbage collector, the scheduler, the heap and so. For example,
62-
using the flag ``+RTS -lg`` you can collect the ``CONC_MARK_BEGIN`` and
63-
``CONC_MARK_END`` events which log the beginning and end of the concurrent
64-
garbage collectors marking phase. Similarly, you can collect ``MEM_RETURN``
65-
which provides information about the current allocation of megablocks, attempts
66-
to return them to the operating system, and heap fragmentation.
58+
Eventlog is most useful when you need to characterize the problem. It yields
59+
runtime information on the specific sub-system the program relies on. Thus, it
60+
allows you to drill down into the behavior of the garbage collector, the
61+
scheduler, the heap and so. For example, using the flag ``+RTS -lg`` you can
62+
collect the ``CONC_MARK_BEGIN`` and ``CONC_MARK_END`` events which log the
63+
beginning and end of the concurrent garbage collectors marking phase. Similarly,
64+
you can collect ``MEM_RETURN`` which provides information about the current
65+
allocation of megablocks, attempts to return them to the operating system, and
66+
heap fragmentation.
6767

6868

6969
The Running Example

Diff for: src/Measurement_Observation/Stg_RTS_Profiling/ghc_debug.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
.. GHC Debug
1+
.. _GHC Debug Chapter:
2+
23

34
:lightgrey:`GHC Debug`
45
======================

Diff for: src/Optimizations/GHC_opt/index.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
Manual GHC Optimizations
2-
------------------------
1+
2+
.. _GHC Optimizations:
3+
4+
GHC Optimizations
5+
-----------------
36

47
.. toctree::
58
:maxdepth: 2
69
:glob:
7-
:name: Man_GHC_Opts
810

911
defunctionalization
1012
sat_transformation

0 commit comments

Comments
 (0)