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