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