haskell / haskell/cabal

Document all stanza types in project.config

Open
#3,812 0 comments 0 reactions 0 assignees View on GitHub
cabal-install: v2-build system documentation
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

I thought I got them all but nope. Grep for SectionDescr in `Distribution/Client/ProjectConfig/Legacy.hs`. We seem to be missing `source-repository-package`, `program-options`, `program-locations` and `repository`.

See also #3579 (we might axe program options/locations).

Contributor guide

Open the contributing guide

Research direction

Start by grepping for SectionDescr in Distribution/Client/ProjectConfig/Legacy.hs and compare the documented stanza types with source-repository-package, program-options, program-locations, and repository. Read issue #3579 before deciding whether program-options and program-locations remain in scope. Done means the relevant project.config documentation covers every stanza type that is still supported.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.