Merge tag '0.31.4'
[notmuch] / Makefile.local
1 # -*- makefile-gmake -*-
2
3 .PHONY: all
4 all: notmuch notmuch-shared build-man build-info ruby-bindings python-cffi-bindings
5 ifeq ($(MAKECMDGOALS),)
6 ifeq ($(shell cat .first-build-message 2>/dev/null),)
7         @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all
8         @echo ""
9         @echo "Compilation of notmuch is now complete. You can install notmuch with:"
10         @echo ""
11         @echo " make install"
12         @echo ""
13         @echo "Note that depending on the prefix to which you are installing"
14         @echo "you may need root permission (such as \"sudo make install\")."
15         @echo "See \"./configure --help\" for help on setting an alternate prefix."
16         @echo Printed > .first-build-message
17 endif
18 endif
19
20 # Depend (also) on the file 'version'. In case of ifeq ($(IS_GIT),yes)
21 # this file may already have been updated.
22 version.stamp: $(srcdir)/version.txt
23         echo $(VERSION) > $@
24
25 $(TAR_FILE):
26         if git tag -v $(UPSTREAM_TAG) >/dev/null 2>&1; then \
27            ref=$(UPSTREAM_TAG); \
28         else \
29            ref="HEAD" ; \
30            echo "Warning: No signed tag for $(VERSION)"; \
31         fi ; \
32         git archive --format=tar --prefix=$(PACKAGE)-$(VERSION)/ $$ref > $(TAR_FILE).tmp
33         echo $(VERSION) > version.txt.tmp
34         ct=`git --no-pager log -1 --pretty=format:%ct $$ref` ; \
35         tar --owner root --group root --append -f $(TAR_FILE).tmp \
36                 --transform s_^_$(PACKAGE)-$(VERSION)/_  \
37                 --transform 's_.tmp$$__' --mtime=@$$ct version.txt.tmp
38         rm version.txt.tmp
39         xz -C sha256 -9 < $(TAR_FILE).tmp > $(TAR_FILE)
40         @echo "Source is ready for release in $(TAR_FILE)"
41
42 $(SHA256_FILE): $(TAR_FILE)
43         sha256sum $^ | gpg --clear-sign --output $@ -
44
45 $(DETACHED_SIG_FILE): $(TAR_FILE)
46         gpg --armor --detach-sign $^
47
48 .PHONY: dist
49 dist: $(TAR_FILE)
50
51 .PHONY: update-versions
52
53 update-versions:
54         sed -i -e "s/^__VERSION__[[:blank:]]*=.*$$/__VERSION__ = \'${VERSION}\'/" \
55             -e "s/^SOVERSION[[:blank:]]*=.*$$/SOVERSION = \'${LIBNOTMUCH_VERSION_MAJOR}\'/" \
56             ${PV_FILE}
57         cp version.txt bindings/python-cffi
58
59 # We invoke make recursively only to force ordering of our phony
60 # targets in the case of parallel invocation of make (-j).
61 #
62 # We carefully ensure that our VERSION variable is passed down to any
63 # sub-ordinate make invocations (which won't otherwise know that they
64 # are part of the release and need to take the version from the
65 # version file).
66 .PHONY: release
67 release: verify-source-tree-and-version
68         $(MAKE) VERSION=$(VERSION) verify-newer
69         $(MAKE) VERSION=$(VERSION) clean
70         $(MAKE) VERSION=$(VERSION) sphinx-html
71         $(MAKE) VERSION=$(VERSION) test
72         git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG)
73         $(MAKE) VERSION=$(VERSION) $(SHA256_FILE) $(DETACHED_SIG_FILE)
74         ln -sf $(TAR_FILE) $(DEB_TAR_FILE)
75         pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG)
76         mkdir -p releases
77         mv $(TAR_FILE) $(SHA256_FILE) $(DETACHED_SIG_FILE) releases
78         $(MAKE) VERSION=$(VERSION) release-message > $(PACKAGE)-$(VERSION).announce
79 ifeq ($(REALLY_UPLOAD),yes)
80         git push origin $(VERSION) release pristine-tar
81         cd releases && scp $(TAR_FILE) $(SHA256_FILE) $(DETACHED_SIG_FILE) $(RELEASE_HOST):$(RELEASE_DIR)
82         ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-* ; ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(TAR_FILE)"
83         rsync --verbose --delete --recursive doc/_build/html/ $(RELEASE_HOST):$(DOC_DIR)
84 endif
85         @echo "Please send a release announcement using $(PACKAGE)-$(VERSION).announce as a template."
86
87 .PHONY: pre-release
88 pre-release:
89         $(MAKE) VERSION=$(VERSION) clean
90         $(MAKE) VERSION=$(VERSION) test
91         git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG)
92         $(MAKE) VERSION=$(VERSION) $(SHA256_FILE) $(DETACHED_SIG_FILE)
93         ln -sf $(TAR_FILE) $(DEB_TAR_FILE)
94         pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG)
95         mkdir -p releases
96         mv $(TAR_FILE) $(DEB_TAR_FILE) releases
97
98 .PHONY: debian-snapshot
99 debian-snapshot:
100         make VERSION=$(VERSION) clean
101         RETVAL=0 &&                                             \
102           TMPFILE=$$(mktemp /tmp/notmuch.XXXXXX) &&             \
103           cp debian/changelog $${TMPFILE} &&                    \
104           (EDITOR=/bin/true dch -b -v $(VERSION)+1              \
105             -D UNRELEASED 'test build, not for upload' &&       \
106           echo '3.0 (native)' > debian/source/format &&         \
107           debuild -us -uc); RETVAL=$$?                          \
108           mv -f $${TMPFILE} debian/changelog;                   \
109           echo '3.0 (quilt)' > debian/source/format;            \
110           exit $$RETVAL
111
112 .PHONY: release-message
113 release-message:
114         @echo "To: notmuch@notmuchmail.org"
115         @echo "Subject: $(PACKAGE) release $(VERSION) now available"
116         @echo ""
117         @echo "Where to obtain notmuch $(VERSION)"
118         @echo "==========================="
119         @echo "  $(RELEASE_URL)/$(TAR_FILE)"
120         @echo ""
121         @echo "Which can be verified with:"
122         @echo ""
123         @echo "  $(RELEASE_URL)/$(SHA256_FILE)"
124         @echo -n "  "
125         @cat releases/$(SHA256_FILE)
126         @echo ""
127         @echo "  $(RELEASE_URL)/$(DETACHED_SIG_FILE)"
128         @echo "  (signed by `getent passwd "$$USER" | cut -d: -f 5 | cut -d, -f 1`)"
129         @echo ""
130         @echo "What's new in notmuch $(VERSION)"
131         @echo "========================="
132         @sed -ne '/^[Nn]otmuch $(VERSION)/{n;n;b NEWS}; d; :NEWS /^===/q; {p;n;b NEWS}' < NEWS | head -n -2
133         @echo ""
134         @echo "What is notmuch"
135         @echo "==============="
136         @echo "Notmuch is a system for indexing, searching, reading, and tagging"
137         @echo "large collections of email messages in maildir or mh format. It uses"
138         @echo "the Xapian library to provide fast, full-text search with a convenient"
139         @echo "search syntax."
140         @echo ""
141         @echo "For more about notmuch, see https://notmuchmail.org"
142
143 # This is a chain of dependencies rather than a simple list simply to
144 # avoid the messages getting interleaved in the case of a parallel
145 # make invocation.
146 .PHONY: verify-source-tree-and-version
147 verify-source-tree-and-version: verify-no-dirty-code
148
149 .PHONY: verify-no-dirty-code
150 verify-no-dirty-code: release-checks
151 ifeq ($(IS_GIT),yes)
152         @printf "Checking that source tree is clean..."
153 ifneq ($(shell git --git-dir=${srcdir}/.git ls-files -m),)
154         @echo "No"
155         @echo "The following files have been modified since the most recent git commit:"
156         @echo ""
157         @git --git-dir=${srcdir}/.git ls-files -m
158         @echo ""
159         @echo "The release will be made from the committed state, but perhaps you meant"
160         @echo "to commit this code first? Please clean this up to make it more clear."
161         @false
162 else
163         @echo "Good"
164 endif
165 endif
166
167 .PHONY: release-checks
168 release-checks:
169         devel/release-checks.sh
170
171 .PHONY: verify-newer
172 verify-newer:
173         @echo -n "Checking that no $(VERSION) release already exists..."
174         @wget -q --no-check-certificate -O /dev/null $(RELEASE_URL)/$(TAR_FILE) ; \
175         case $$? in \
176           8) echo "Good." ;; \
177           0) echo "Ouch."; \
178              echo "Found: $(RELEASE_URL)/$(TAR_FILE)"; \
179              echo "Refusing to replace an existing release."; \
180              echo "Don't forget to update \"version\" as described in RELEASING before release." ; \
181              false ;; \
182           *) echo "An unexpected error occurred"; \
183              false;; esac
184
185 # The user has not set any verbosity, default to quiet mode and inform the
186 # user how to enable verbose compiles.
187 ifeq ($(V),)
188 quiet_DOC := "Use \"$(MAKE) V=1\" to see the verbose compile lines.\n"
189 quiet = @printf $(quiet_DOC)$(eval quiet_DOC:=)"$(1) $(or $(2),$@)\n"; $($(word 1, $(1)))
190 endif
191 # The user has explicitly enabled quiet compilation.
192 ifeq ($(V),0)
193 quiet = @printf "$(1) $(or $(2),$@)\n"; $($(word 1, $(1)))
194 endif
195 # Otherwise, print the full command line.
196 quiet ?= $($(word 1, $(1)))
197
198 %.o: %.cc $(global_deps)
199         @mkdir -p $(patsubst %/.,%,.deps/$(@D))
200         $(call quiet,CXX $(CPPFLAGS) $(CXXFLAGS)) -c $(FINAL_CXXFLAGS) $< -o $@ -MD -MP -MF .deps/$*.d
201
202 %.o: %.c $(global_deps)
203         @mkdir -p $(patsubst %/.,%,.deps/$(@D))
204         $(call quiet,CC $(CPPFLAGS) $(CFLAGS)) -c $(FINAL_CFLAGS) $< -o $@ -MD -MP -MF .deps/$*.d
205
206 CPPCHECK=cppcheck
207 .stamps/cppcheck/%: %
208         @mkdir -p $(@D)
209         $(call quiet,CPPCHECK,$<) --template=gcc --error-exitcode=1 --quiet $<
210         @touch $@
211
212 CLEAN := $(CLEAN) .stamps
213
214 .PHONY : clean
215 clean:
216         rm -rf $(CLEAN)
217
218 .PHONY: distclean
219 distclean: clean
220         rm -rf $(DISTCLEAN)
221
222 .PHONY: dataclean
223 dataclean: distclean
224         rm -rf $(DATACLEAN)
225
226 notmuch_client_srcs =           \
227         $(notmuch_compat_srcs)  \
228         command-line-arguments.c\
229         debugger.c              \
230         status.c                \
231         gmime-filter-reply.c    \
232         hooks.c                 \
233         notmuch.c               \
234         notmuch-compact.c       \
235         notmuch-config.c        \
236         notmuch-count.c         \
237         notmuch-dump.c          \
238         notmuch-insert.c        \
239         notmuch-new.c           \
240         notmuch-reindex.c       \
241         notmuch-reply.c         \
242         notmuch-restore.c       \
243         notmuch-search.c        \
244         notmuch-setup.c         \
245         notmuch-show.c          \
246         notmuch-tag.c           \
247         notmuch-time.c          \
248         sprinter-json.c         \
249         sprinter-sexp.c         \
250         sprinter-text.c         \
251         query-string.c          \
252         mime-node.c             \
253         tag-util.c
254
255 notmuch_client_modules = $(notmuch_client_srcs:.c=.o)
256
257 notmuch.o: version.stamp
258
259 notmuch: $(notmuch_client_modules) lib/libnotmuch.a util/libnotmuch_util.a parse-time-string/libparse-time-string.a
260         $(call quiet,CXX $(CFLAGS)) $^ $(FINAL_LIBNOTMUCH_LDFLAGS) -o $@
261
262 notmuch-shared: $(notmuch_client_modules) lib/$(LINKER_NAME)
263         $(call quiet,$(FINAL_NOTMUCH_LINKER) $(CFLAGS)) $(notmuch_client_modules) $(FINAL_NOTMUCH_LDFLAGS) -o $@
264
265 .PHONY: install
266 install: all install-man install-info
267         mkdir -p "$(DESTDIR)$(prefix)/bin/"
268         install notmuch-shared "$(DESTDIR)$(prefix)/bin/notmuch"
269 ifeq ($(MAKECMDGOALS), install)
270         @echo ""
271         @echo "Notmuch is now installed to $(DESTDIR)$(prefix)"
272         @echo ""
273         @echo "New users should simply run \"notmuch\" to be guided"
274         @echo "through the process of configuring notmuch and creating"
275         @echo "a database of existing email messages. The \"notmuch\""
276         @echo "command will also offer some sample search commands."
277 ifeq ($(WITH_EMACS), 1)
278         @echo ""
279         @echo "Beyond the command-line interface, notmuch also offers"
280         @echo "a full-featured interface for reading and writing mail"
281         @echo "within emacs. To use this, each user should add the"
282         @echo "following line to the ~/.emacs file:"
283         @echo ""
284         @echo " (require 'notmuch)"
285         @echo ""
286         @echo "And then run emacs as \"emacs -f notmuch\" or invoke"
287         @echo "the command \"M-x notmuch\" from within emacs."
288 endif
289 endif
290
291 SRCS  := $(SRCS) $(notmuch_client_srcs)
292 CLEAN := $(CLEAN) notmuch notmuch-shared $(notmuch_client_modules)
293 CLEAN := $(CLEAN) version.stamp notmuch-*.tar.gz.tmp
294 CLEAN := $(CLEAN) .deps
295
296 DISTCLEAN := $(DISTCLEAN) .first-build-message Makefile.config sh.config sphinx.config
297
298 CPPCHECK_STAMPS := $(SRCS:%=.stamps/cppcheck/%)
299 .PHONY: cppcheck
300 ifeq ($(HAVE_CPPCHECK),1)
301 cppcheck: ${CPPCHECK_STAMPS}
302 else
303 cppcheck:
304         @echo "No cppcheck found during configure; skipping static checking"
305 endif
306
307
308 DEPS := $(SRCS:%.c=.deps/%.d)
309 DEPS := $(DEPS:%.cc=.deps/%.d)
310 -include $(DEPS)
311
312 .SUFFIXES: # Delete the default suffixes. Old-Fashioned Suffix Rules not used.