|
1 | 1 | help: ## Print documentation |
2 | | - @{ grep -hE '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST); echo -e '$(EXTRA_HELP)'; } | sed 's/^ //' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-33s\033[0m %s\n", $$1, $$2}' |
| 2 | + @grep -hE '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sed 's/^ //' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-33s\033[0m %s\n", $$1, $$2}' |
3 | 3 |
|
4 | | -include lib.mk |
5 | 4 | include nix.mk |
6 | 5 |
|
7 | 6 | PROJECT_NAME = cardano-node |
8 | 7 | NUM_PROC = $(nproc --all) |
9 | 8 |
|
10 | | -PROFILE ?= default |
11 | | -## One of: shelley allegra mary alonzo babbage conway dijkstra |
12 | | -ERA ?= conway |
13 | | -BACKEND ?= supervisor |
14 | | -REV ?= master |
15 | | -ITER ?= |
16 | | -BATCH ?= |
17 | | -ARGS ?= |
18 | | -CMD ?= |
19 | | -RUN ?= |
20 | | - |
21 | 9 | lint hlint: ## Run the CI version of hlint |
22 | 10 | nix build --no-link '.#checks/hlint' --cores 0 |
23 | 11 | haddock-hoogle haddocks hoogle: |
@@ -50,75 +38,46 @@ trace-schemas-validate: ## Validate trace message schemas against meta.schema.js |
50 | 38 | nix run .#validate-trace-schemas |
51 | 39 |
|
52 | 40 | ### |
53 | | -### Workbench |
| 41 | +### Workbench: cluster shells |
54 | 42 | ### |
| 43 | +## `make shell` (and -nix/-prof/-dev) opens a workbench dev shell for $(PROFILE) -- the usual |
| 44 | +## entry point (below). `make <profile>[-VARIANT]` are per-profile aliases; `make ps` lists |
| 45 | +## profile names. Targets, flags and the (generated) profile lists all live in |
| 46 | +## nix/workbench/lib.mk (which pulls in profiles.mk itself). |
| 47 | +include nix/workbench/lib.mk |
| 48 | + |
| 49 | +## Dev shells -- the usual entry point; each runs $(WB_ENTER) (defined in nix/workbench/lib.mk). |
| 50 | +shell: ## workbench dev shell for PROFILE (cabal build-on-demand); vars: PROFILE ERA BACKEND CMD RUN |
| 51 | + $(WB_ENTER) |
| 52 | +shell-nix: ## like shell, but run the Nix-store binary |
| 53 | + $(WB_ENTER) --arg useCabalRun false |
| 54 | +shell-prof: ## like shell, profiled build, run with -hT |
| 55 | + $(WB_ENTER) --arg profiledBuild true --arg profilingType '"space-heap"' |
| 56 | +shell-dev: |
| 57 | + $(WB_ENTER) |
| 58 | +.PHONY: shell shell-nix shell-prof shell-dev |
| 59 | + |
| 60 | +## CI entrypoints (drive the generated variant targets + Nix ci-test): |
55 | 61 | workbench-ci: workbench-ci-test ci-test-auto ci-test-autonix |
56 | 62 | CI_TARGETS := hlint workbench-ci haddock-hoogle |
57 | 63 | ci: ci-report ci-targets |
58 | 64 | ci-report: |
59 | 65 | @echo -e "\033[34mGoals under test\033[0m: \033[33m$(CI_TARGETS)\033[0m" |
60 | 66 | ci-targets: $(CI_TARGETS) |
61 | 67 |
|
62 | | -workbench-internals-walkthrough: |
63 | | - emn nix/workbench/doc.org |
64 | | - |
65 | | -# Alias for removed profiles: inject RTS -hT (space-heap) heap profile + -l (eventlog) as shell parameters on a NON-profiled build. |
66 | | -# Neither -hT nor -l needs a profiled runtime, so delegate to the base target, not -prof (a -prof target hardcodes --arg profiledBuild true). |
67 | | -6-dense-rtsprof: |
68 | | - WB_PROFILING="space-heap+eventlog" $(MAKE) 6-dense |
69 | | -6-dense-1h-rtsprof: |
70 | | - WB_PROFILING="space-heap+eventlog" $(MAKE) 6-dense-1h |
71 | | -6-dense-4h-rtsprof: |
72 | | - WB_PROFILING="space-heap+eventlog" $(MAKE) 6-dense-4h |
73 | | - |
74 | | -## |
75 | | -## Base targets: |
76 | | -## |
77 | | -shell: ## Nix shell, (workbench from /nix/store), vars: PROFILE, ERA, CMD, RUN |
78 | | - nix-shell -A 'workbench-shell' --max-jobs 8 --cores 0 --show-trace --argstr profileName ${PROFILE} --argstr eraName ${ERA} --argstr backendName ${BACKEND} ${ARGS} ${if ${CMD},--command "${CMD}"} ${if ${RUN},--run "${RUN}"} |
79 | | -shell-dev shell-prof shell-nix: shell |
80 | | -shell-nix: ARGS += --arg 'useCabalRun' false ## Nix shell, (workbench from Nix store), vars: PROFILE, CMD, RUN |
81 | | -shell-prof: ARGS += --arg 'profiledBuild' true --arg 'profilingType' '"space-heap"' ## Nix shell, everything Haskell built profiled and run with `-hT`. |
82 | | - |
83 | | -analyse: RUN := wb analyse std ${TAG} |
84 | | -analyse: shell |
85 | | - |
86 | | -list-profiles: ## List workbench profiles |
87 | | - nix build .#all-profiles-json && cat result |
88 | | -show-profile: ## NAME=profile-name |
89 | | - @test -n "${NAME}" || { echo 'HELP: to specify profile to show, add NAME=profle-name' && exit 1; } |
90 | | - nix build .#all-profiles-json --json --option substitute false | jq '.[0].outputs.out' -r | xargs jq ".\"${NAME}\" | if . == null then error(\"\n###\n### Error: unknown profile: ${NAME} Please consult: make list-profiles\n###\") else . end" |
91 | | -ps: ## Plain-text list of profiles |
92 | | - @nix build .#workbench.profile-names-json --json | jq '.[0].outputs.out' -r | xargs jq '.[]' --raw-output |
93 | | - |
94 | | -## |
95 | | -## Profile-based cluster shells (autogenerated targets) |
96 | | -## |
97 | | -## wb_profiles.mk is autogenerated by `cardano-profile lib-make`. It contains all known profile families and flavours (minus the era, backend and shell type suffixes). |
98 | | -## After adding or removing profile definitions in `cardano-profile`, you'll probably want to also commit a regenerated version of that file. |
99 | | -## |
100 | | -include wb_profiles.mk |
101 | | - |
102 | | -$(eval $(call define_profile_targets, $(LOCAL_PROFILES))) |
103 | | -$(eval $(call define_profile_targets_nomadcloud,$(CLOUD_PROFILES))) |
104 | | - |
105 | | -# Dynamic local/supervisor profile targets. |
106 | | -playground-%: |
107 | | - nix-shell -A 'workbench-shell' --max-jobs 8 --cores 0 --show-trace --argstr profileName $* --argstr eraName ${ERA} --argstr backendName supervisor |
108 | | - |
109 | 68 | ### |
110 | 69 | ### Misc |
111 | 70 | ### |
112 | | -clean-profile proclean: |
113 | | - rm -f *.html *.prof *.hp *.stats *.eventlog |
114 | | - |
115 | 71 | clean: clean-profile |
116 | | - rm -rf logs/ socket/ cluster.* |
117 | 72 |
|
118 | 73 | full-clean: clean |
119 | 74 | rm -rf db dist-newstyle $(shell find . -name '*~' -or -name '*.swp') |
120 | 75 |
|
121 | 76 | cls: |
122 | 77 | echo -en "\ec" |
123 | 78 |
|
124 | | -.PHONY: cabal-hashes clean cli cls cluster-profiles help node run-test shell shell-dev stylish-haskell $(LOCAL_PROFILES) workbench-ci-test |
| 79 | +.PHONY: help lint hlint host-hlint haddock-hoogle stylish-haskell cabal-hashes cli node \ |
| 80 | + trace-documentation trace-schemas-regenerate trace-schemas-overrides-check \ |
| 81 | + trace-schemas-overrides-coverage trace-schemas-validate \ |
| 82 | + workbench-ci ci ci-report ci-targets \ |
| 83 | + clean full-clean cls |
0 commit comments