haskell/haskell-ide-engine

Suggstion: ship with profiling disabled via stack-8.x.x.yaml

Open

#1,248 opened on May 8, 2019

View on GitHub
聽(5 comments)聽(0 reactions)聽(0 assignees)Haskell聽(2,358 stars)聽(205 forks)batch import
Well Defined Task - Awaiting PRbuildgardening 馃尡good first issue

Description

Related to #1214, which reports that building with profiling on under stack doesn't work.

Some developers may have profiling on by default with stack (i.e. library-profiling: true and executable-profiling: true in ~/.stack/config.yaml). I do this because I want profiling on more often than I want it off, and because it takes a long time to switch between profiling and non-profiling builds with stack. This configuration caused building HIE to fail and it took quite a while to figure out why.

As long as profiling doesn't work out of the box with stack, might it make sense ship with profiling explicitly disabled in stack-8.x.x.yaml?

build:
  library-profiling: false
  executable-profiling: false

Contributor guide

Tech stack
None
Domain
build systemtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Stack build toolUnderstanding of profiling flags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the file stack 8.x.x.yaml in the repository. The suggestion is to add build configuration options to disable profiling explicitly. Refer to the related issue #1214 for context on why profiling causes build failures. Check if there are any recent comments or updates on this issue to ensure the approach is still valid.
Suggstion: ship with profiling disabled via stack-8.x.x.yaml 路 haskell/haskell-ide-engine#1248 | Good First Issue