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