1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
## Copyright (C) 2008-2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software Foundation,
## Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# Makefile with some useful targets for meson/ninja
V ?= 0
BUILDDIR ?= $(CURDIR)/build
COVERAGE_BUILDDIR ?= $(CURDIR)/build-coverage
GENHTML ?= genhtml
LCOV ?= lcov
MAKEINFO ?= makeinfo
MESON ?= meson
NINJA ?= ninja
VALGRIND ?= valgrind
ifneq ($(V),0)
VERBOSE=--verbose
endif
# when MU_HACKER is set, do a debug build
# MU_HACKER is for djcb & compatible developers
# note that mu uses C++17, we only pass C++20 here
# for the better error messages (esp. for fmt).
ifneq (${MU_HACKER},)
MESON_FLAGS:=$(MESON_FLAGS) '-Dbuildtype=debug' \
'-Db_sanitize=address' \
'-Dreadline=enabled' \
'-Dcpp_std=c++20'
endif
.PHONY: all
.PHONY: check test test-verbose-if-fail test-valgrind test-helgrind
.PHONY: benchmark coverage
.PHONY: dist install uninstall clean distclean
.PHONY: mu4e-doc-html
# MESON_FLAGS, e.g. "-Dreadline=enabled"
# examples:
# 1. build with clang, and the thread-sanitizer
# make clean all MESON_FLAGS="-Db_sanitize=thread" CXX=clang++ CC=clang
all: $(BUILDDIR)
@$(MESON) compile -C $(BUILDDIR) $(VERBOSE)
@ln -sf $(BUILDDIR)/compile_commands.json $(CURDIR) || /bin/true
$(BUILDDIR):
@$(MESON) setup $(MESON_FLAGS) $(BUILDDIR)
check: test
test: all
@$(MESON) test $(VERBOSE) -C $(BUILDDIR)
install: $(BUILDDIR)
@$(MESON) install -C $(BUILDDIR) $(VERBOSE)
uninstall: $(BUILDDIR)
@$(NINJA) -C $(BUILDDIR) uninstall
clean:
@rm -rf $(BUILDDIR) $(COVERAGE_BUILDDIR)
#
# below targets are just for development/testing/debugging. They may or
# may not work on your system.
#
test-verbose-if-fail: all
$(MESON) test -C $(BUILDDIR) || $(MESON) test -C $(BUILDDIR) --verbose
vg_opts:=--enable-debuginfod=no --leak-check=full --error-exitcode=1
test-valgrind: export G_SLICE=always-malloc
test-valgrind: export G_DEBUG=gc-friendly
test-valgrind: $(BUILDDIR)
@cd $(BUILDDIR); $(MESON) test \
--wrap="$(VALGRIND) $(vg_opts)" \
--timeout-multiplier 100
# we do _not_ pass helgrind; but this seems to be a false-alarm
# https://gitlab.gnome.org/GNOME/glib/-/issues/2662
# test-helgrind: $(BUILDDIR)
# @cd $(BUILDDIR); TEST=HELGRIND $(MESON) test \
# --wrap='valgrind --tool=helgrind --error-exitcode=1' \
# --timeout-multiplier 100
benchmark: $(BUILDDIR)
$(NINJA) -C $(BUILDDIR) benchmark
$(COVERAGE_BUILDDIR):
$(MESON) setup -Db_coverage=true --buildtype=debug $(COVERAGE_BUILDDIR)
covfile:=$(COVERAGE_BUILDDIR)/meson-logs/coverage.info
# generate by hand, meson's built-ins are unflexible
coverage: $(COVERAGE_BUILDDIR)
@$(MESON) test -C $(COVERAGE_BUILDDIR) $(VERBOSE)
$(LCOV) --capture --directory . --output-file $(covfile)
@$(LCOV) --remove $(covfile) '/usr/*' '*guile*' '*thirdparty*' '*/tests/*' '*mime-object*' --output $(covfile)
@$(LCOV) --remove $(covfile) '*mu/mu/*' --output $(covfile)
@mkdir -p $(COVERAGE_BUILDDIR)/meson-logs/coverage
@$(GENHTML) $(covfile) --output-directory $(COVERAGE_BUILDDIR)/meson-logs/coverage/
@echo "coverage report at: file://$(COVERAGE_BUILDDIR)/meson-logs/coverage/index.html"
dist: $(BUILDDIR)
$(MESON) dist -C $(BUILDDIR) $(VERBOSE)
distclean: clean
HTMLPATH=${BUILDDIR}/mu4e/mu4e
mu4e-doc-html:
@mkdir -p ${HTMLPATH} && cp mu4e/texinfo-klare.css ${HTMLPATH}
@makeinfo -I ${BUILDDIR}/mu4e --html --css-ref=texinfo-klare.css -o ${HTMLPATH} mu4e/mu4e.texi
|
