Skip to content

Add a doctest-% pattern target #11799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
philderbeast wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add a doctest-% pattern target #11799

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0dc5eae
Add doctest-% pattern target
philderbeast May 6, 2026
b1ad94e
Use REPL_WITH_DOCTEST when necessary
philderbeast May 7, 2026
a0753a4
Try doctest-0.25.0 and cabal-doctest for cabal-testsuite
philderbeast Jun 7, 2026
3d4aabd
Note cabal-testsuite --keep-temp-files error
philderbeast Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
CABALBUILD := cabal build
CABALRUN := cabal run

DOCTEST := cabal doctest
CABAL_DOCTEST := cabal doctest
REPL_WITH_DOCTEST := cabal repl --with-compiler=doctest --build-depends=QuickCheck --verbose=0 --repl-options='-w -Wdefault -Wno-inconsistent-flags'
Comment thread
ulysses4ever marked this conversation as resolved.

# default rules

Expand Down Expand Up @@ -158,14 +159,41 @@ ghcid-lib: ## Run ghcid for the Cabal library.
ghcid-cli: ## Run ghcid for the cabal-install executable.
ghcid -c 'cabal repl cabal-install'

.PHONY: doctest
doctest: ## Run doctests.
# doctests

# To find package directories that might have doctests:
# $ grep --exclude generics-sop-lens.hs -E "\- >>>" **/*.hs | awk -F/ '{print $1}' | sort -u
DOCTEST_PACKAGES := \
Cabal \
Cabal-described \
Cabal-syntax \
cabal-install \
cabal-install-solver \
# Can't include cabal-testsuite because of the --keep-temp-files problem
# cabal-testsuite

DOCTEST_TARGETS := $(addprefix doctest-, $(DOCTEST_PACKAGES))

doctest-%: ## Run doctests for a specific package.
cabal --numeric-version
cd Cabal-syntax && $(DOCTEST)
cd Cabal-described && $(DOCTEST)
cd Cabal && $(DOCTEST)
cd cabal-install-solver && $(DOCTEST)
cd cabal-install && $(DOCTEST)
@echo "Running doctests for $*:" && cd $* && $(CABAL_DOCTEST) $*

doctest-PACKAGENAME: ## Run doctests for a single package (replace PACKAGENAME).
@echo 'Please use one of the following targets:'
@printf "%s\n" $(DOCTEST_TARGETS)

Comment thread
ulysses4ever marked this conversation as resolved.
# TODO: Fix this problem
# Configuring cabal-testsuite-3...
# unrecognized 'repl' option `--keep-temp-files'
# Error: [Cabal-7125]
# repl failed for cabal-testsuite-3.
# make: *** [Makefile:172: doctest-cabal-testsuite] Error 1
doctest-cabal-testsuite: ## Run doctests for a specific package.
@echo "Running doctests for cabal-testsuite:" && $(CABAL_DOCTEST) cabal-testsuite

.PHONY: doctest
doctest: ## Run doctests in all packages.
doctest: $(DOCTEST_TARGETS)

# If we pin and periodically bump the version of doctest, we get more
# reproducible testing. Initially we pinned to doctest-0.25.0 to avoid failures
Expand Down
Loading