Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading documentation about profiling #1241

Closed
brprice opened this issue Sep 19, 2021 · 5 comments
Closed

Misleading documentation about profiling #1241

brprice opened this issue Sep 19, 2021 · 5 comments

Comments

@brprice
Copy link

brprice commented Sep 19, 2021

[Related issues: #793 , #887]

Searching the docs for profiling only brings up one relevant section: Troubleshooting:Nix-only configuration options, where setting profiling: true in cabal.project is mentioned as better than doing the setting via nix, to "ensure that the two builds agree".
(The relevant source is https://github.com/input-output-hk/haskell.nix/blame/master/docs/troubleshooting.md#L69)

Unfortunately, due to #887, this is known not to work! (And is rather confusing if one is trying to work out how to turn profiling on.)

Is there some other common option to use as an example which haskell.nix does, in fact, read from cabal.project that we could use as an example instead?

@georgefst
Copy link
Contributor

Based on #839 (comment), I'd guess that this does work with the v1-* cabal commands, hence the example being chosen originally.

Of course, the v2-* commands have been the default for about two years now, so this is not ideal.

@michaelpj
Copy link
Collaborator

Yes, this is an unfortunate example. tests:true might be a better one.

@stale
Copy link

stale bot commented Jan 18, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Jan 18, 2023
@georgefst
Copy link
Contributor

Still an issue.

@stale stale bot closed this as completed Mar 20, 2023
@dhess
Copy link
Contributor

dhess commented Mar 20, 2023

Bump.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants