[philderbeast]

A follow on from #10608 but for adding help to the doc/Makefile, fixing #10596.

I'll squash commits before applying the merge label if this pull request is approved.

---

• Patches conform to the coding conventions.
• Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

[leana8959]

I think these ? quantifiers are redundant, otherwise lgtm :)

[philderbeast]

I think these ? quantifiers are redundant, otherwise lgtm :)

Thanks @leana8959. Both grep -E and awk use POSIX extended regular expressions, so the ? works like optional rather than non-greedy.

Note, I copied the regex from the main Makefile into doc/Makefile but there we have rules with digits so had to account for that. I felt it better to have the same regex in both files so copied those changes back.

cabal/Makefile

Lines 343 to 346 in aca9bd4

	.PHONY: help
	help: ## Show the commented targets.
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
	sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

[leana8959]

Thank you :)

[mergify]

❌ Left the queue · Validate old ghcs 8.0.2 failed

3 h 32 min in the queue, 1 h 36 min of it CI.

So far

• ✅ Entered the queue Wed 11 Nov, 15:28 · rule default · triggered by rule Put pull requests in the rebase+merge queue
• ❌ Checks failed 15:30 · draft merge queue: checking #12310 + #12497 together on master (3c15ba7) #12575
  • ❌ Validate post job (job log)
  • ❌ Validate old ghcs 8.0.2 (job log)
  • ❌ Validate old ghcs 8.10.7 (job log)
  • ❌ Validate old ghcs 8.2.2 (job log)
  • ❌ Validate old ghcs 8.4.4 (job log)
  • ❌ Validate old ghcs 8.6.5 (job log)
  • ❌ Validate old ghcs 8.8.4 (job log)
  • ❌ Validate old ghcs 9.0.2 (job log)
  • ❌ Validate old ghcs 9.2.8 (job log)
• ✂️ Bisecting to identify the failing PR (round 1/1)
• 🚫 Left the queue 19:00 · d8fc67f

Not proven to be this pull request's failure. It failed in a batch with #12310, and was not tested alone.

Reason

The merge conditions cannot be satisfied due to failing checks

• Validate post job

Failing checks:

• ❌ Validate old ghcs 8.0.2 (job log)
• ❌ Validate old ghcs 8.10.7 (job log)
• ❌ Validate old ghcs 8.2.2 (job log)
• ❌ Validate old ghcs 8.4.4 (job log)
• ❌ Validate old ghcs 8.6.5 (job log)
• ❌ Validate old ghcs 8.8.4 (job log)
• ❌ Validate old ghcs 9.0.2 (job log)
• ❌ Validate old ghcs 9.2.8 (job log)
• ❌ Validate post job (job log)

To get back in the queue

• If the failure comes from the pull requests it was tested with, or is a flake, comment @mergifyio queue to queue it again as it is.
• If it is this pull request's, push a fix: the pull request is queued again once its queue conditions match.

_{Times in UTC · dashboard · how the merge queue works}

[zlonast]

@Mergifyio queue

[mergify]

✅ Merged into master as 9ebb809 at 06:12 UTC

Merged together with #12549. 2 h 14 min in the queue, 2 h 4 min of it CI.

So far

• ✅ Entered the queue Thu 12 Nov, 03:58 · rule default · triggered by @zlonast with the @mergifyio queue command
• ✅ Passed · draft merge queue: merged #12549, #12497: Fix dead docs link in v1- command help text (+1 more) #12579
• ✅ Merged 06:12 · 9ebb809 · merge

12 merge conditions met

• #review-threads-unresolved = 0 · required by GitHub branch protection
• github-review-approved · required by GitHub branch protection
• any of · required by GitHub branch protection:
  • check-success = Doctest Cabal
  • check-neutral = Doctest Cabal
  • check-skipped = Doctest Cabal
• any of · required by GitHub branch protection:
  • check-success = Meta checks
  • check-neutral = Meta checks
  • check-skipped = Meta checks
• any of · required by GitHub branch protection:
  • check-success = docs/readthedocs.org:cabal
  • check-neutral = docs/readthedocs.org:cabal
  • check-skipped = docs/readthedocs.org:cabal
• any of · required by GitHub branch protection:
  • check-success = Validate post job
  • check-neutral = Validate post job
  • check-skipped = Validate post job
• any of · required by GitHub branch protection:
  • check-success = fourmolu
  • check-neutral = fourmolu
  • check-skipped = fourmolu
• any of · required by GitHub branch protection:
  • check-success = hlint
  • check-neutral = hlint
  • check-skipped = hlint
• any of · required by GitHub branch protection:
  • check-success = Bootstrap post job
  • check-neutral = Bootstrap post job
  • check-skipped = Bootstrap post job
• any of · required by GitHub branch protection:
  • check-success = whitespace
  • check-neutral = whitespace
  • check-skipped = whitespace
• any of · required by GitHub branch protection:
  • check-success = Check sdist post job
  • check-neutral = Check sdist post job
  • check-skipped = Check sdist post job
• any of · required by GitHub branch protection:
  • check-success = Changelogs
  • check-neutral = Changelogs
  • check-skipped = Changelogs

_{Times in UTC · dashboard · how the merge queue works}