Makefile

   1 .PHONY : all lexer sdpx lib exe doctest
   2 .PHONY : phony
   3
   4 CABALBUILD := cabal build
   5 CABALRUN   := cabal 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 init: ## Set up git hooks and ignored revisions
  18         @git config core.hooksPath .githooks
  19         ## TODO
  20
  21 style: ## Run the code styler
  22         @fourmolu -q -i Cabal Cabal-syntax cabal-install
  23
  24 style-modified: ## Run the code styler on modified files
  25         @git ls-files --modified Cabal Cabal-syntax cabal-install \
  26                 | grep '.hs$$' | xargs -P $(PROCS) -I {} fourmolu -q -i {}
  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 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 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 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 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 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 run --builddir=dist-newstyle-meta --project-file=cabal.project.meta analyse-imports --
  65
  66 # ghcid
  67
  68 ghcid-lib :
  69         ghcid -c 'cabal repl Cabal'
  70
  71 ghcid-cli :
  72         ghcid -c 'cabal 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.doctest" Cabal-syntax
  85         cabal repl --with-ghc=doctest --build-depends=QuickCheck --build-depends=template-haskell --repl-options="-w" --project-file="cabal.project.doctest" 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         $(CABALBUILD) -j3 cabal-tests cabal
 117         rm -rf .ghc.environment.*
 118         cd cabal-testsuite && `cabal list-bin cabal-tests` --with-cabal=`cabal list-bin cabal` --hide-successes -j3 ${TEST}
 119
 120 # hackage-benchmarks (solver)
 121
 122 hackage-benchmarks-run:
 123         $(CABALBUILD) -j3 hackage-benchmark cabal
 124         rm -rf .ghc.environment.*
 125         $$(cabal list-bin hackage-benchmark) --cabal1=cabal --cabal2=$$(cabal list-bin cabal) --packages="hakyll servant-auth-server" --print-trials --concurrently
 126
 127
 128 # This doesn't run build, as you first need to test with cabal-install-test :)
 129 cabal-install-test-accept:
 130         rm -rf .ghc.environment.*
 131         cd cabal-testsuite && `cabal list-bin cabal-tests` --with-cabal=`cabal list-bin cabal` --hide-successes -j3 --accept ${TEST}
 132
 133 # Docker validation
 134
 135 # Use this carefully, on big machine you can say
 136 #
 137 #   make validate-via-docker-all -j4 -O
 138 #
 139 validate-via-docker-all : validate-via-docker-8.2.2
 140 validate-via-docker-all : validate-via-docker-8.4.4
 141 validate-via-docker-all : validate-via-docker-8.6.5
 142 validate-via-docker-all : validate-via-docker-8.8.4
 143 validate-via-docker-all : validate-via-docker-8.10.4
 144
 145 validate-dockerfiles : .docker/validate-8.10.4.dockerfile
 146 validate-dockerfiles : .docker/validate-8.8.4.dockerfile
 147 validate-dockerfiles : .docker/validate-8.6.5.dockerfile
 148 validate-dockerfiles : .docker/validate-8.4.4.dockerfile
 149 validate-dockerfiles : .docker/validate-8.2.2.dockerfile
 150
 151 .docker/validate-%.dockerfile : .docker/validate.dockerfile.zinza cabal-dev-scripts/src/GenValidateDockerfile.hs
 152         cabal run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-validate-dockerfile -- $* $< $@
 153
 154 # This is good idea anyway
 155 # and we have a test relying on this limit being sufficiently small
 156 DOCKERARGS:=--ulimit nofile=1024:1024
 157
 158 validate-via-docker-8.2.2:
 159         docker build $(DOCKERARGS) -t cabal-validate:8.2.2 -f .docker/validate-8.2.2.dockerfile .
 160
 161 validate-via-docker-8.4.4:
 162         docker build $(DOCKERARGS) -t cabal-validate:8.4.4 -f .docker/validate-8.4.4.dockerfile .
 163
 164 validate-via-docker-8.6.5:
 165         docker build $(DOCKERARGS) -t cabal-validate:8.6.5 -f .docker/validate-8.6.5.dockerfile .
 166
 167 validate-via-docker-8.8.4:
 168         docker build $(DOCKERARGS) -t cabal-validate:8.8.4 -f .docker/validate-8.8.4.dockerfile .
 169
 170 validate-via-docker-8.10.4:
 171         docker build $(DOCKERARGS) -t cabal-validate:8.10.4 -f .docker/validate-8.10.4.dockerfile .
 172
 173 validate-via-docker-old:
 174         docker build $(DOCKERARGS) -t cabal-validate:older -f .docker/validate-old.dockerfile .
 175
 176 # Weeder
 177 weeder :
 178         cabal build all --project-file=cabal.project.weeder
 179         weeder | less
 180
 181 # tags
 182 .PHONY : tags
 183 tags :
 184         hasktags -b Cabal-syntax/src Cabal/src Cabal-described/src cabal-install/src cabal-testsuite/src
 185
 186 # bootstrapping
 187 ##############################################################################
 188
 189 bootstrap-json-%: phony
 190         cabal build --project=cabal.project.release --with-compiler=ghc-$* --dry-run cabal-install:exe:cabal
 191         cp dist-newstyle/cache/plan.json bootstrap/linux-$*.plan.json
 192         @# -v0 to avoid build output on stdout
 193         cd bootstrap && cabal run -v0 cabal-bootstrap-gen -- linux-$*.plan.json \
 194                 | python3 -m json.tool > linux-$*.json
 195
 196 BOOTSTRAP_GHC_VERSIONS := 8.10.7 9.0.2 9.2.7 9.4.4
 197
 198 bootstrap-jsons: $(BOOTSTRAP_GHC_VERSIONS:%=bootstrap-json-%)
 199
 200 # documentation
 201 ##############################################################################
 202
 203 .PHONY: users-guide
 204 users-guide:
 205         $(MAKE) -C doc users-guide
 206
 207 .PHONY: users-guide-requirements
 208 users-guide-requirements:
 209         $(MAKE) -C doc users-guide-requirements
 210
 211 ifeq ($(shell uname), Darwin)
 212 PROCS := $(shell sysctl -n hw.logicalcpu)
 213 else
 214 PROCS := $(shell nproc)
 215 endif