Skip to content

Commit 82f7fb1

Browse files
committed
Rename the post
1 parent eb046f0 commit 82f7fb1

File tree

3 files changed

+36
-22
lines changed

3 files changed

+36
-22
lines changed

content/how-to-analyse-haskell-performance/index.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
+++
2+
title = "How to configure a Cabal project for profiling"
3+
date = 2024-11-27
4+
[taxonomies]
5+
authors = ["Hécate"]
6+
categories = ["Cabal"]
7+
tags = ["Performance", "Profiling"]
8+
+++
9+
10+
The [Cabal Manual][Cabal Manual] now has a guide on how to analyse the performance of Haskell applications.
11+
12+
<!-- more -->
13+
14+
This guide was contributed very generously by Malte Neuss. It describes the various options you can set in your `cabal.project` file in order to get a time or space profile of your application.
15+
16+
## Project Configuration Guide
17+
18+
It is the recommended entry point for newcomers into the world of Haskell performance analysis.
19+
As you progress through it, you will be pointed to other resources like the [Profiling section of the GHC Users Guide][GHC] and the [Haskell Optimization Handbook][HsOpt],
20+
which present you with more in-depth techniques and configuration options.
21+
22+
You will moreover be shown how to produce time and space profiles that can be rendered and analysed with third-party tools like [Speedscope](https://speedscope.app).
23+
24+
<img src=./speedscope.png />
25+
26+
You can read it there: <https://cabal.readthedocs.io/en/latest/how-to-analyze-haskell-code-performance.html>.
27+
28+
## Contribute to the documentation
29+
30+
The manual follows the [documentation best practices](@/documentation-best-practices-in-2024/index.md) of the Haddock team, and the Cabal team is eager to receive more contributions to improve the life
31+
of our users. Do not hesitate to open a pull request at <https://github.com/haskell/cabal>.
32+
33+
34+
[Cabal Manual]: https://cabal.readthedocs.io/en/latest/
35+
[GHC]: https://downloads.haskell.org/ghc/latest/docs/users_guide/profiling.html
36+
[HsOpt]: https://haskell.foundation/hs-opt-handbook.github.io/
288 KB
Loading

0 commit comments

Comments
 (0)