clash-lang / clash-lang/clash-protocols
`clash-protocols` should not use `Protocols.Plugin.Cpp`
- Dominant language
- Haskell
- Stars
- 26
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
1. The `maxTupleSize` is wrong in the Haddock for `clash-protocols`. It is supposed to be 3, but when generating Haddock for `clash-protocols`, `clash-protocols-base` is compiled _without_ `-DHADDOCK_ONLY` and so `maxTupleSize` is 12.
2. We define a `large-tuples` flag in `clash-protocols`, but it is unused. Instead, the flag of `clash-protocols-base` determines `maxTupleSize` for `clash-protocols`.
Contributor guide
No contributing guide indexed for this repository
Research direction
Inspect the package definitions for clash-protocols and clash-protocols-base, then reproduce Haddock generation for clash-protocols to trace how the large-tuples flags are applied. Done means Haddock reports maxTupleSize as 3 and the clash-protocols flag is no longer unused or incorrectly overridden.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100