new: Defer updating directory mtimes until the end.
[notmuch] / Makefile.local
1 # -*- makefile -*-
2
3 # Here's the (hopefully simple) versioning scheme.
4 #
5 # Releases of notmuch have a two-digit version (0.1, 0.2, etc.). We
6 # increment the second digit for each release and increment the first
7 # digit when we reach particularly major milestones of usability.
8 #
9 # Between releases, (such as when compiling notmuch from the git
10 # repository), we let git append identification of the actual commit.
11 PACKAGE=notmuch
12
13 IS_GIT=$(shell if [ -d .git ] ; then echo yes ; else echo no; fi)
14
15 VERSION:=$(shell cat ${srcdir}/version)
16 ifneq ($(MAKECMDGOALS),release)
17 ifneq ($(MAKECMDGOALS),release-message)
18 ifneq ($(MAKECMDGOALS),pre-release)
19 ifeq ($(IS_GIT),yes)
20 VERSION:=$(shell git describe --match '[0-9.]*')
21 endif
22 endif
23 endif
24 endif
25
26 UPSTREAM_TAG=$(subst ~,_,$(VERSION))
27 DEB_TAG=debian/$(UPSTREAM_TAG)-1
28
29 RELEASE_HOST=notmuchmail.org
30 RELEASE_DIR=/srv/notmuchmail.org/www/releases
31 RELEASE_URL=http://notmuchmail.org/releases
32 TAR_FILE=$(PACKAGE)-$(VERSION).tar.gz
33 DEB_TAR_FILE=$(PACKAGE)_$(VERSION).orig.tar.gz
34 SHA1_FILE=$(TAR_FILE).sha1
35 GPG_FILE=$(SHA1_FILE).asc
36
37 PV_FILE=bindings/python/notmuch/version.py
38
39 # Smash together user's values with our extra values
40 FINAL_CFLAGS = -DNOTMUCH_VERSION=$(VERSION) $(CFLAGS) $(WARN_CFLAGS) $(CONFIGURE_CFLAGS) $(extra_cflags)
41 FINAL_CXXFLAGS = $(CXXFLAGS) $(WARN_CXXFLAGS) $(CONFIGURE_CXXFLAGS) $(extra_cflags) $(extra_cxxflags)
42 FINAL_NOTMUCH_LDFLAGS = $(LDFLAGS) -Llib -lnotmuch $(AS_NEEDED_LDFLAGS) $(GMIME_LDFLAGS) $(TALLOC_LDFLAGS)
43 FINAL_NOTMUCH_LINKER = CC
44 ifneq ($(LINKER_RESOLVES_LIBRARY_DEPENDENCIES),1)
45 FINAL_NOTMUCH_LDFLAGS += $(CONFIGURE_LDFLAGS)
46 FINAL_NOTMUCH_LINKER = CXX
47 endif
48 ifeq ($(LIBDIR_IN_LDCONFIG),0)
49 FINAL_NOTMUCH_LDFLAGS += $(RPATH_LDFLAGS)
50 endif
51 FINAL_LIBNOTMUCH_LDFLAGS = $(LDFLAGS) $(AS_NEEDED_LDFLAGS) $(CONFIGURE_LDFLAGS)
52
53 .PHONY: all
54 all: notmuch notmuch-shared notmuch.1.gz
55 ifeq ($(MAKECMDGOALS),)
56 ifeq ($(shell cat .first-build-message 2>/dev/null),)
57         @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all
58         @echo ""
59         @echo "Compilation of notmuch is now complete. You can install notmuch with:"
60         @echo ""
61         @echo " make install"
62         @echo ""
63         @echo "Note that depending on the prefix to which you are installing"
64         @echo "you may need root permission (such as \"sudo make install\")."
65         @echo "See \"./configure --help\" for help on setting an alternate prefix."
66         @echo Printed > .first-build-message
67 endif
68 endif
69
70 $(TAR_FILE):
71         if git tag -v $(VERSION) >/dev/null 2>&1; then \
72            ref=$(VERSION); \
73         else \
74            ref="HEAD" ; \
75            echo "Warning: No signed tag for $(VERSION)"; \
76         fi ; \
77         git archive --format=tar --prefix=$(PACKAGE)-$(VERSION)/ $$ref > $(TAR_FILE).tmp
78         echo $(VERSION) > version.tmp
79         tar --append -f $(TAR_FILE).tmp --transform s_^_$(PACKAGE)-$(VERSION)/_  --transform 's_.tmp$$__' version.tmp
80         rm version.tmp
81         gzip < $(TAR_FILE).tmp > $(TAR_FILE)
82         @echo "Source is ready for release in $(TAR_FILE)"
83
84 $(SHA1_FILE): $(TAR_FILE)
85         sha1sum $^ > $@
86
87 $(GPG_FILE): $(SHA1_FILE)
88         @echo "Please enter your GPG password to sign the checksum."
89         gpg --armor --sign $^ 
90
91 .PHONY: dist
92 dist: $(TAR_FILE)
93
94 # We invoke make recursively only to force ordering of our phony
95 # targets in the case of parallel invocation of make (-j).
96 #
97 # We carefully ensure that our VERSION variable is passed down to any
98 # sub-ordinate make invocations (which won't otherwise know that they
99 # are part of the release and need to take the version from the
100 # version file).
101 .PHONY: release
102 release: verify-source-tree-and-version
103         $(MAKE) VERSION=$(VERSION) verify-newer
104         $(MAKE) VERSION=$(VERSION) clean
105         $(MAKE) VERSION=$(VERSION) test
106         git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG)
107         $(MAKE) VERSION=$(VERSION) $(GPG_FILE)
108         ln -sf $(TAR_FILE) $(DEB_TAR_FILE)
109         pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG)
110         git tag -s -m "$(PACKAGE) Debian $(VERSION)-1 upload (same as $(VERSION))" $(DEB_TAG)
111         mkdir -p releases
112         mv $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) releases
113         $(MAKE) VERSION=$(VERSION) release-message > $(PACKAGE)-$(VERSION).announce
114 ifeq ($(REALLY_UPLOAD),yes)
115         git push origin $(VERSION)
116         cd releases && scp $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) $(RELEASE_HOST):$(RELEASE_DIR)
117         ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-[0-9]* ; ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(PACKAGE)-$(VERSION)"
118 endif
119         @echo "Please send a release announcement using $(PACKAGE)-$(VERSION).announce as a template."
120
121 .PHONY: pre-release
122 pre-release:
123         $(MAKE) VERSION=$(VERSION) clean
124         $(MAKE) VERSION=$(VERSION) test
125         git tag -s -m "$(PACKAGE) $(VERSION) release" $(UPSTREAM_TAG)
126         git tag -s -m "$(PACKAGE) Debian $(VERSION)-1 upload (same as $(VERSION))" $(DEB_TAG)
127         $(MAKE) VERSION=$(VERSION) $(TAR_FILE)
128         ln -sf $(TAR_FILE) $(DEB_TAR_FILE)
129         pristine-tar commit $(DEB_TAR_FILE) $(UPSTREAM_TAG)
130         mkdir -p releases
131         mv $(TAR_FILE) $(DEB_TAR_FILE) releases
132
133 .PHONY: release-message
134 release-message:
135         @echo "To: notmuch@notmuchmail.org"
136         @echo "Subject: $(PACKAGE) release $(VERSION) now available"
137         @echo ""
138         @echo "Where to obtain notmuch $(VERSION)"
139         @echo "==========================="
140         @echo "  $(RELEASE_URL)/$(TAR_FILE)"
141         @echo ""
142         @echo "Which can be verified with:"
143         @echo ""
144         @echo "  $(RELEASE_URL)/$(SHA1_FILE)"
145         @echo -n "  "
146         @cat releases/$(SHA1_FILE)
147         @echo ""
148         @echo "  $(RELEASE_URL)/$(GPG_FILE)"
149         @echo "  (signed by `getent passwd "$$USER" | cut -d: -f 5 | cut -d, -f 1`)"
150         @echo ""
151         @echo "What's new in notmuch $(VERSION)"
152         @echo "========================="
153         @sed -ne '/^[Nn]otmuch $(VERSION)/{n;n;b NEWS}; d; :NEWS /^===/q; {p;n;b NEWS}' < NEWS | head -n -2
154         @echo ""
155         @echo "What is notmuch"
156         @echo "==============="
157         @echo "Notmuch is a system for indexing, searching, reading, and tagging"
158         @echo "large collections of email messages in maildir or mh format. It uses"
159         @echo "the Xapian library to provide fast, full-text search with a convenient"
160         @echo "search syntax."
161         @echo ""
162         @echo "For more about notmuch, see http://notmuchmail.org"
163
164 # This is a chain of dependencies rather than a simple list simply to
165 # avoid the messages getting interleaved in the case of a parallel
166 # make invocation.
167 .PHONY: verify-source-tree-and-version
168 verify-source-tree-and-version: verify-no-dirty-code
169
170 .PHONY: verify-no-dirty-code
171 verify-no-dirty-code: verify-version-debian verify-version-python
172 ifeq ($(IS_GIT),yes)
173         @printf "Checking that source tree is clean..."
174 ifneq ($(shell git ls-files -m),)
175         @echo "No"
176         @echo "The following files have been modified since the most recent git commit:"
177         @echo ""
178         @git ls-files -m
179         @echo ""
180         @echo "The release will be made from the committed state, but perhaps you meant"
181         @echo "to commit this code first? Please clean this up to make it more clear."
182         @false
183 else
184         @echo "Good"
185 endif
186 endif
187
188 .PHONY: verify-version-debian
189 verify-version-debian: verify-version-components
190         @echo -n "Checking that Debian package version is $(VERSION)-1..."
191         @if [ "$(VERSION)-1" != $$(dpkg-parsechangelog | grep ^Version | awk '{print $$2}') ] ; then \
192                 (echo "No." && \
193                  echo "Please edit version and debian/changelog to have consistent versions." && false) \
194          fi
195         @echo "Good."
196
197 .PHONY: verify-version-python
198 verify-version-python: verify-version-components
199         @echo -n "Checking that python bindings version is $(VERSION)..."
200         @if [ "$(VERSION)" != $$(python -c "execfile('$(PV_FILE)'); print __VERSION__") ] ; then \
201                 (echo "No." && \
202                  echo "Please edit version and $(PV_FILE) to have consistent versions." && false) \
203          fi
204         @echo "Good."
205
206 .PHONY: verify-version-components
207 verify-version-components:
208         @echo -n "Checking that $(VERSION) consists only of digits and periods..."
209         @if echo $(VERSION) | grep -q -v -x '[0-9.]*'; then \
210                 (echo "No." && \
211                  echo "Please follow the instructions in RELEASING to choose a version" && false) \
212          else :; fi
213         @echo "Good."
214
215 .PHONY: verify-newer
216 verify-newer:
217         @echo -n "Checking that no $(VERSION) release already exists..."
218         @wget -q -O /dev/null $(RELEASE_URL)/$(TAR_FILE) ; \
219         case $$? in \
220           8) echo "Good." ;; \
221           0) echo "Ouch."; \
222              echo "Found: $(RELEASE_URL)/$(TAR_FILE)"; \
223              echo "Refusing to replace an existing release."; \
224              echo "Don't forget to update \"version\" as described in RELEASING before release." ; \
225              false ;; \
226           *) echo "An unexpected error occured"; \
227              false;; esac
228
229 # The user has not set any verbosity, default to quiet mode and inform the
230 # user how to enable verbose compiles.
231 ifeq ($(V),)
232 quiet_DOC := "Use \"$(MAKE) V=1\" to see the verbose compile lines.\n"
233 quiet = @printf $(quiet_DOC)$(eval quiet_DOC:=)"$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//'))
234 endif
235 # The user has explicitly enabled quiet compilation.
236 ifeq ($(V),0)
237 quiet = @printf "$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//'))
238 endif
239 # Otherwise, print the full command line.
240 quiet ?= $($(shell echo $1 | sed -e s'/ .*//'))
241
242 %.o: %.cc $(global_deps)
243         $(call quiet,CXX $(CXXFLAGS)) -c $(FINAL_CXXFLAGS) $< -o $@
244
245 %.o: %.c $(global_deps)
246         $(call quiet,CC $(CFLAGS)) -c $(FINAL_CFLAGS) $< -o $@
247
248 .deps/%.d: %.c $(global_deps)
249         @set -e; rm -f $@; mkdir -p $$(dirname $@) ; \
250         $(CC) -M $(CPPFLAGS) $(FINAL_CFLAGS) $< > $@.$$$$ 2>/dev/null ; \
251         sed 's,'$$(basename $*)'\.o[ :]*,$*.o $@ : ,g' < $@.$$$$ > $@; \
252         rm -f $@.$$$$
253
254 .deps/%.d: %.cc $(global_deps)
255         @set -e; rm -f $@; mkdir -p $$(dirname $@) ; \
256         $(CXX) -M $(CPPFLAGS) $(FINAL_CXXFLAGS) $< > $@.$$$$ 2>/dev/null ; \
257         sed 's,'$$(basename $*)'\.o[ :]*,$*.o $@ : ,g' < $@.$$$$ > $@; \
258         rm -f $@.$$$$
259
260 DEPS := $(SRCS:%.c=.deps/%.d)
261 DEPS := $(DEPS:%.cc=.deps/%.d)
262 -include $(DEPS)
263
264 .PHONY : clean
265 clean:
266         rm -f $(CLEAN); rm -rf .deps
267
268 # We don't (yet) have any distributed files not in the upstream repository.
269 # So distclean is currently identical to clean.
270 .PHONY: distclean
271 distclean: clean
272
273 notmuch_client_srcs =           \
274         debugger.c              \
275         gmime-filter-reply.c    \
276         gmime-filter-headers.c  \
277         notmuch.c               \
278         notmuch-config.c        \
279         notmuch-count.c         \
280         notmuch-dump.c          \
281         notmuch-new.c           \
282         notmuch-reply.c         \
283         notmuch-restore.c       \
284         notmuch-search.c        \
285         notmuch-setup.c         \
286         notmuch-show.c          \
287         notmuch-tag.c           \
288         notmuch-time.c          \
289         query-string.c          \
290         show-message.c          \
291         json.c                  \
292         xutil.c
293
294 notmuch_client_modules = $(notmuch_client_srcs:.c=.o)
295
296 notmuch: $(notmuch_client_modules) lib/libnotmuch.a
297         $(call quiet,CXX $(CFLAGS)) $^ $(FINAL_LIBNOTMUCH_LDFLAGS) -o $@
298
299 notmuch-shared: $(notmuch_client_modules) lib/$(LINKER_NAME)
300         $(call quiet,$(FINAL_NOTMUCH_LINKER) $(CFLAGS)) $(notmuch_client_modules) $(FINAL_NOTMUCH_LDFLAGS) -o $@
301
302 notmuch.1.gz: notmuch.1
303         gzip --stdout $^ > $@
304
305 .PHONY: install
306 install: all notmuch.1.gz
307         mkdir -p "$(DESTDIR)$(mandir)/man1"
308         install -m0644 notmuch.1.gz "$(DESTDIR)$(mandir)/man1/"
309         mkdir -p "$(DESTDIR)$(prefix)/bin/"
310         install notmuch-shared "$(DESTDIR)$(prefix)/bin/notmuch"
311 ifeq ($(MAKECMDGOALS), install)
312         @echo ""
313         @echo "Notmuch is now installed to $(DESTDIR)$(prefix)"
314         @echo ""
315         @echo "New users should simply run \"notmuch\" to be guided"
316         @echo "through the process of configuring notmuch and creating"
317         @echo "a database of existing email messages. The \"notmuch\""
318         @echo "command will also offer some sample search commands."
319 ifeq ($(WITH_EMACS), 1)
320         @echo ""
321         @echo "Beyond the command-line interface, notmuch also offers"
322         @echo "a full-featured interface for reading and writing mail"
323         @echo "within emacs. To use this, each user should add the"
324         @echo "following line to the ~/.emacs file:"
325         @echo ""
326         @echo " (require 'notmuch)"
327         @echo ""
328         @echo "And then run emacs as \"emacs -f notmuch\" or invoke"
329         @echo "the command \"M-x notmuch\" from within emacs."
330 endif
331 endif
332
333 .PHONY: install-desktop
334 install-desktop:
335         mkdir -p "$(DESTDIR)$(desktop_dir)"
336         desktop-file-install --mode 0644 --dir "$(DESTDIR)$(desktop_dir)" notmuch.desktop
337
338 SRCS  := $(SRCS) $(notmuch_client_srcs)
339 CLEAN := $(CLEAN) notmuch notmuch-shared $(notmuch_client_modules) notmuch.elc notmuch.1.gz