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