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