Makefile

   1 .PHONY : all lexer sdpx lib exe doctest
   2 .PHONY : phony
   3
   4 CABALBUILD := cabal v2-build
   5 CABALRUN   := cabal v2-run
   6
   7 # default rules
   8
   9 all : exe lib
  10
  11 lib : $(LEXER_HS)
  12         $(CABALBUILD) Cabal:libs
  13
  14 exe : $(LEXER_HS)
  15         $(CABALBUILD) cabal-install:exes
  16
  17 # source generation: Lexer
  18
  19 LEXER_HS:=Cabal-syntax/src/Distribution/Fields/Lexer.hs
  20
  21 lexer : $(LEXER_HS)
  22
  23 $(LEXER_HS) : templates/Lexer.x
  24         alex --latin1 --ghc -o $@ $^
  25         cat -s $@ > Lexer.tmp
  26         mv Lexer.tmp $@
  27
  28 # source generation: SPDX
  29
  30 SPDX_LICENSE_HS:=Cabal-syntax/src/Distribution/SPDX/LicenseId.hs
  31 SPDX_EXCEPTION_HS:=Cabal-syntax/src/Distribution/SPDX/LicenseExceptionId.hs
  32
  33 spdx : $(SPDX_LICENSE_HS) $(SPDX_EXCEPTION_HS)
  34
  35 SPDX_LICENSE_VERSIONS:=3.0 3.2 3.6 3.9 3.10 3.16
  36
  37 $(SPDX_LICENSE_HS) : templates/SPDX.LicenseId.template.hs cabal-dev-scripts/src/GenUtils.hs cabal-dev-scripts/src/GenSPDX.hs license-list-data/licenses-3.0.json license-list-data/licenses-3.2.json
  38         cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-spdx -- templates/SPDX.LicenseId.template.hs $(SPDX_LICENSE_VERSIONS:%=license-list-data/licenses-%.json) $(SPDX_LICENSE_HS)
  39
  40 $(SPDX_EXCEPTION_HS) : templates/SPDX.LicenseExceptionId.template.hs cabal-dev-scripts/src/GenUtils.hs cabal-dev-scripts/src/GenSPDXExc.hs license-list-data/exceptions-3.0.json license-list-data/exceptions-3.2.json
  41         cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-spdx-exc -- templates/SPDX.LicenseExceptionId.template.hs $(SPDX_LICENSE_VERSIONS:%=license-list-data/exceptions-%.json) $(SPDX_EXCEPTION_HS)
  42
  43 # source generation: templates
  44
  45 TEMPLATE_MACROS:=Cabal/src/Distribution/Simple/Build/Macros/Z.hs
  46 TEMPLATE_PATHS:=Cabal/src/Distribution/Simple/Build/PathsModule/Z.hs
  47
  48 templates : phony $(TEMPLATE_MACROS) $(TEMPLATE_PATHS)
  49
  50 $(TEMPLATE_MACROS) : templates/cabal_macros.template.h cabal-dev-scripts/src/GenCabalMacros.hs
  51         cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-cabal-macros -- $< $@
  52
  53 $(TEMPLATE_PATHS) : templates/Paths_pkg.template.hs cabal-dev-scripts/src/GenPathsModule.hs
  54         cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-paths-module -- $< $@
  55
  56 # generated docs
  57
  58 buildinfo-fields-reference : phony
  59         cabal build --builddir=dist-newstyle-bi --project-file=cabal.project.buildinfo buildinfo-reference-generator
  60         $$(cabal-plan list-bin --builddir=dist-newstyle-bi buildinfo-reference-generator) buildinfo-reference-generator/template.zinza | tee $@
  61
  62 # analyse-imports
  63 analyse-imports : phony
  64         find Cabal-syntax/src Cabal/src cabal-install/src -type f -name '*.hs' | xargs cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta analyse-imports --
  65
  66 # ghcid
  67
  68 ghcid-lib :
  69         ghcid -c 'cabal v2-repl Cabal'
  70
  71 ghcid-cli :
  72         ghcid -c 'cabal v2-repl cabal-install'
  73
  74 # Artem, 2023-02-03, https://github.com/haskell/cabal/issues/8504
  75 # The new and prefered way to call the doctest tool (as of now) is based on cabal repl --with-ghc=doctest.
  76 # The call below reflects the current documentation of the doctest tool except one caveat,
  77 # which is https://github.com/haskell/cabal/issues/6859, i.e. we have to hide allow-newer in our project
  78 # file from cabal/doctest. This is easy: we just select a project file with no allow-newer (e.g. cabal.project.libonly).
  79 #
  80 # TODO: Cabal-described should be added here but its doctests currently broken, see:
  81 #       https://github.com/haskell/cabal/issues/8734
  82 #       Just as well, cabal-install(-solver) doctests (the target below) bitrotted and need some care.
  83 doctest :
  84         cabal repl --with-ghc=doctest --build-depends=QuickCheck --build-depends=template-haskell --repl-options="-w" --project-file="cabal.project.validate" Cabal-syntax
  85         cabal repl --with-ghc=doctest --build-depends=QuickCheck --build-depends=template-haskell --repl-options="-w" --project-file="cabal.project.validate" Cabal
  86
  87
  88 # This is not run as part of validate.sh (we need hackage-security, which is tricky to get).
  89 doctest-cli :
  90         doctest -D__DOCTEST__ --fast cabal-install/src cabal-install-solver/src cabal-install-solver/src-assertion
  91
  92 doctest-install:
  93         cabal install doctest --overwrite-policy=always --ignore-project
  94
  95 # tests
  96
  97 check-tests :
  98         $(CABALRUN) check-tests -- --cwd Cabal-tests ${TEST}
  99
 100 parser-tests :
 101         $(CABALRUN) parser-tests -- --cwd Cabal-tests ${TEST}
 102
 103 parser-tests-accept :
 104         $(CABALRUN) parser-tests -- --cwd Cabal-tests --accept ${TEST}
 105
 106 custom-setup-tests :
 107         $(CABALRUN) custom-setup-tests --
 108
 109 hackage-parsec-tests :
 110         $(CABALRUN) hackage-tests -- parsec +RTS -s -qg -I0 -A64M -N${THREADS} -RTS ${TEST}
 111
 112 hackage-roundtrip-tests :
 113         $(CABALRUN) hackage-tests -- roundtrip +RTS -s -qg -I0 -A64M -N${THREADS} -RTS ${TEST}
 114
 115 cabal-install-test:
 116         @which cabal-plan
 117         $(CABALBUILD) -j3 cabal-tests cabal
 118         rm -rf .ghc.environment.*
 119         cd cabal-testsuite && `cabal-plan list-bin cabal-tests` --with-cabal=`cabal-plan list-bin cabal` --hide-successes -j3 ${TEST}
 120
 121 # hackage-benchmarks (solver)
 122
 123 hackage-benchmarks-run:
 124         $(CABALBUILD) -j3 hackage-benchmark cabal
 125         rm -rf .ghc.environment.*
 126         $$(cabal-plan list-bin hackage-benchmark) --cabal1=cabal --cabal2=$$(cabal-plan list-bin cabal) --packages="hakyll servant-auth-server" --print-trials --concurrently
 127
 128
 129 # This doesn't run build, as you first need to test with cabal-install-test :)
 130 cabal-install-test-accept:
 131         @which cabal-plan
 132         rm -rf .ghc.environment.*
 133         cd cabal-testsuite && `cabal-plan list-bin cabal-tests` --with-cabal=`cabal-plan list-bin cabal` --hide-successes -j3 --accept ${TEST}
 134
 135 # Docker validation
 136
 137 # Use this carefully, on big machine you can say
 138 #
 139 #   make validate-via-docker-all -j4 -O
 140 #
 141 validate-via-docker-all : validate-via-docker-8.2.2
 142 validate-via-docker-all : validate-via-docker-8.4.4
 143 validate-via-docker-all : validate-via-docker-8.6.5
 144 validate-via-docker-all : validate-via-docker-8.8.4
 145 validate-via-docker-all : validate-via-docker-8.10.4
 146
 147 validate-dockerfiles : .docker/validate-8.10.4.dockerfile
 148 validate-dockerfiles : .docker/validate-8.8.4.dockerfile
 149 validate-dockerfiles : .docker/validate-8.6.5.dockerfile
 150 validate-dockerfiles : .docker/validate-8.4.4.dockerfile
 151 validate-dockerfiles : .docker/validate-8.2.2.dockerfile
 152
 153 .docker/validate-%.dockerfile : .docker/validate.dockerfile.zinza cabal-dev-scripts/src/GenValidateDockerfile.hs
 154         cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-validate-dockerfile -- $* $< $@
 155
 156 # This is good idea anyway
 157 # and we have a test relying on this limit being sufficiently small
 158 DOCKERARGS:=--ulimit nofile=1024:1024
 159
 160 validate-via-docker-8.2.2:
 161         docker build $(DOCKERARGS) -t cabal-validate:8.2.2 -f .docker/validate-8.2.2.dockerfile .
 162
 163 validate-via-docker-8.4.4:
 164         docker build $(DOCKERARGS) -t cabal-validate:8.4.4 -f .docker/validate-8.4.4.dockerfile .
 165
 166 validate-via-docker-8.6.5:
 167         docker build $(DOCKERARGS) -t cabal-validate:8.6.5 -f .docker/validate-8.6.5.dockerfile .
 168
 169 validate-via-docker-8.8.4:
 170         docker build $(DOCKERARGS) -t cabal-validate:8.8.4 -f .docker/validate-8.8.4.dockerfile .
 171
 172 validate-via-docker-8.10.4:
 173         docker build $(DOCKERARGS) -t cabal-validate:8.10.4 -f .docker/validate-8.10.4.dockerfile .
 174
 175 validate-via-docker-old:
 176         docker build $(DOCKERARGS) -t cabal-validate:older -f .docker/validate-old.dockerfile .
 177
 178 # Weeder
 179 weeder :
 180         cabal build all --project-file=cabal.project.weeder
 181         weeder | less
 182
 183 # tags
 184 .PHONY : tags
 185 tags :
 186         hasktags -b Cabal-syntax/src Cabal/src Cabal-described/src cabal-install/src cabal-testsuite/src
 187
 188 # bootstrapping
 189 ##############################################################################
 190
 191 bootstrap-json-%: phony
 192         cabal v2-build --project=cabal.project.release --with-compiler=ghc-$* --dry-run cabal-install:exe:cabal
 193         cp dist-newstyle/cache/plan.json bootstrap/linux-$*.plan.json
 194         @# -v0 to avoid build output on stdout
 195         cd bootstrap && cabal v2-run -v0 cabal-bootstrap-gen -- linux-$*.plan.json \
 196                 | python3 -m json.tool > linux-$*.json
 197
 198 BOOTSTRAP_GHC_VERSIONS := 8.10.7 9.0.2 9.2.6 9.4.4
 199
 200 bootstrap-jsons: $(BOOTSTRAP_GHC_VERSIONS:%=bootstrap-json-%)
 201
 202 # documentation
 203 ##############################################################################
 204
 205 # TODO: when we have sphinx-build2 ?
 206 SPHINXCMD:=sphinx-build
 207 # Flag -n ("nitpick") warns about broken references
 208 # Flag -W turns warnings into errors
 209 # Flag --keep-going continues after errors
 210 SPHINX_FLAGS:=-n -W --keep-going -E
 211 SPHINX_HTML_OUTDIR:=dist-newstyle/doc/users-guide
 212 USERGUIDE_STAMP:=$(SPHINX_HTML_OUTDIR)/index.html
 213
 214 # do pip install every time so we have up to date requirements when we build
 215 users-guide: .python-sphinx-virtualenv $(USERGUIDE_STAMP)
 216 $(USERGUIDE_STAMP) : doc/*.rst
 217         mkdir -p $(SPHINX_HTML_OUTDIR)
 218         (. ./.python-sphinx-virtualenv/bin/activate && pip install -r doc/requirements.txt && $(SPHINXCMD) $(SPHINX_FLAGS) doc $(SPHINX_HTML_OUTDIR))
 219
 220 .python-sphinx-virtualenv:
 221         python3 -m venv .python-sphinx-virtualenv
 222         (. ./.python-sphinx-virtualenv/bin/activate)
 223
 224 # This goal is intended for manual invocation, always rebuilds.
 225 .PHONY: users-guide-requirements
 226 users-guide-requirements: doc/requirements.txt
 227
 228 .PHONY: doc/requirements.txt
 229 doc/requirements.txt: .python-sphinx-virtualenv
 230         . .python-sphinx-virtualenv/bin/activate \
 231           && make -C doc build-and-check-requirements