haskell / haskell/cabal

Build differences between `v2-run` and `v2-exec` not documented

Open
#7,106 0 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/exec cabal-install: cmd/run documentation
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

**Describe the bug**
Differences between `v2-run` and `v2-exec` w.r.t. build-related behavior is not documented.

**To Reproduce**
Observe that when running:

```
$ mkdir exec-vs-run && cd exec-vs-run
$ cabal init -n
$ cabal v2-build
...
$ cabal v2-exec exec-vs-run
Hello, Haskell!
$ sed -i 's/Hello/Bonjour/g' Main.hs
$ cabal v2-exec exec-vs-run
Hello, Haskell!
$ cabal v2-run exec-vs-run
...
Bonjour, Haskell!
```

that `v2-exec` will not build or rebuild a project to incorporate any recent changes, whereas `v2-run` will.

**Expected behavior**
Cabal documentation alludes to this difference.

**System information**
- Operating system: Any? (MacOS in my case)
- `cabal` version 3.0.0.0, `ghc` version 8.8.3

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Cabal documentation for the v2-run and v2-exec commands, then reproduce the shown edit-and-run sequence. Document the build and rebuild difference clearly, including when each command incorporates source changes, and verify the wording against both commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.