git.notmuchmail.org Git - notmuch/blob - 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         rm -rf ./debian-build
  93         git-buildpackage
  94         cp debian-build/notmuch_$(VERSION).tar.gz notmuch-$(VERSION).tar.gz
  95         $(MAKE) VERSION=$(VERSION) $(GPG_FILE)
  96         scp $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) $(RELEASE_HOST):$(RELEASE_DIR)
  97         ssh $(RELEASE_HOST) "rm -f $(RELEASE_DIR)/LATEST-$(PACKAGE)-[0-9]* && ln -s $(TAR_FILE) $(RELEASE_DIR)/LATEST-$(PACKAGE)-$(VERSION)"
  98         mkdir -p releases
  99         mv $(TAR_FILE) $(SHA1_FILE) $(GPG_FILE) releases
 100         (cd debian-build; dput *.changes)
 101         mv debian-build/* releases
 102         rmdir debian-build
 103         git tag -s -m "$(PACKAGE) $(VERSION) release" $(VERSION)
 104         git push origin $(VERSION)
 105         $(MAKE) VERSION=$(VERSION) release-message > $(PACKAGE)-$(VERSION).announce
 106         @echo "Please send a release announcement using $(PACKAGE)-$(VERSION).announce as a template."
 107
 108 .PHONY: release-message
 109 release-message:
 110         @echo "To: notmuch@notmuchmail.org"
 111         @echo "Subject: $(PACKAGE) release $(VERSION) now available"
 112         @echo ""
 113         @echo "Where to obtain notmuch $(VERSION)"
 114         @echo "==========================="
 115         @echo "  $(RELEASE_URL)/$(TAR_FILE)"
 116         @echo ""
 117         @echo "Which can be verified with:"
 118         @echo ""
 119         @echo "  $(RELEASE_URL)/$(SHA1_FILE)"
 120         @echo -n "  "
 121         @cat releases/$(SHA1_FILE)
 122         @echo ""
 123         @echo "  $(RELEASE_URL)/$(GPG_FILE)"
 124         @echo "  (signed by `getent passwd "$$USER" | cut -d: -f 5 | cut -d, -f 1`)"
 125         @echo ""
 126         @echo "What's new in notmuch $(VERSION)"
 127         @echo "========================="
 128         @sed -ne '/^[Nn]otmuch $(VERSION)/{n;n;b NEWS}; d; :NEWS /^===/q; {p;n;b NEWS}' < NEWS | head -n -2
 129         @echo ""
 130         @echo "What is notmuch"
 131         @echo "==============="
 132         @echo "Notmuch is a system for indexing, searching, reading, and tagging"
 133         @echo "large collections of email messages in maildir or mh format. It uses"
 134         @echo "the Xapian library to provide fast, full-text search with a convenient"
 135         @echo "search syntax."
 136         @echo ""
 137         @echo "For more about notmuch, see http://notmuchmail.org"
 138
 139 # This is a chain of dependencies rather than a simple list simply to
 140 # avoid the messages getting interleaved in the case of a parallel
 141 # make invocation.
 142 .PHONY: verify-source-tree-and-version
 143 verify-source-tree-and-version: verify-no-dirty-code
 144
 145 .PHONY: verify-no-dirty-code
 146 verify-no-dirty-code: verify-version-debian
 147 ifeq ($(IS_GIT),yes)
 148         @printf "Checking that source tree is clean..."
 149 ifneq ($(shell git ls-files -m),)
 150         @echo "No"
 151         @echo "The following files have been modified since the most recent git commit:"
 152         @echo ""
 153         @git ls-files -m
 154         @echo ""
 155         @echo "The release will be made from the committed state, but perhaps you meant"
 156         @echo "to commit this code first? Please clean this up to make it more clear."
 157         @false
 158 else
 159         @echo "Good"
 160 endif
 161 endif
 162
 163 .PHONY: verify-version-debian
 164 verify-version-debian: verify-version-components
 165         @echo -n "Checking that Debian package version is $(VERSION)..."
 166         @if [ "$(VERSION)" != $$(dpkg-parsechangelog | grep ^Version | awk '{print $$2}') ] ; then \
 167                 (echo "No." && \
 168                  echo "Please edit version and debian/changelog to have consistent versions." && false) \
 169          fi
 170         @echo "Good."
 171
 172 .PHONY: verify-version-components
 173 verify-version-components:
 174         @echo -n "Checking that $(VERSION) consists only of digits and periods..."
 175         @if echo $(VERSION) | grep -q -v -x '[0-9.]*'; then \
 176                 (echo "No." && \
 177                  echo "Please follow the instructions in RELEASING to choose a version" && false) \
 178          else :; fi
 179         @echo "Good."
 180
 181 .PHONY: verify-newer
 182 verify-newer:
 183         @echo -n "Checking that no $(VERSION) release already exists..."
 184         @ssh $(RELEASE_HOST) test ! -e $(RELEASE_DIR)/$(TAR_FILE) \
 185                 || (echo "Ouch." && echo "Found: $(RELEASE_HOST):$(RELEASE_DIR)/$(TAR_FILE)" \
 186                 && echo "Refusing to replace an existing release." \
 187                 && echo "Don't forget to update \"version\" as described in RELEASING before release." && false)
 188         @echo "Good."
 189
 190 # The user has not set any verbosity, default to quiet mode and inform the
 191 # user how to enable verbose compiles.
 192 ifeq ($(V),)
 193 quiet_DOC := "Use \"$(MAKE) V=1\" to see the verbose compile lines.\n"
 194 quiet = @printf $(quiet_DOC)$(eval quiet_DOC:=)"$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//'))
 195 endif
 196 # The user has explicitly enabled quiet compilation.
 197 ifeq ($(V),0)
 198 quiet = @printf "$1 $@\n"; $($(shell echo $1 | sed -e s'/ .*//'))
 199 endif
 200 # Otherwise, print the full command line.
 201 quiet ?= $($(shell echo $1 | sed -e s'/ .*//'))
 202
 203 %.o: %.cc $(global_deps)
 204         $(call quiet,CXX $(CXXFLAGS)) -c $(FINAL_CXXFLAGS) $< -o $@
 205
 206 %.o: %.c $(global_deps)
 207         $(call quiet,CC $(CFLAGS)) -c $(FINAL_CFLAGS) $< -o $@
 208
 209 .deps/%.d: %.c $(global_deps)
 210         @set -e; rm -f $@; mkdir -p $$(dirname $@) ; \
 211         $(CC) -M $(CPPFLAGS) $(FINAL_CFLAGS) $< > $@.$$$$ 2>/dev/null ; \
 212         sed 's,'$$(basename $*)'\.o[ :]*,$*.o $@ : ,g' < $@.$$$$ > $@; \
 213         rm -f $@.$$$$
 214
 215 .deps/%.d: %.cc $(global_deps)
 216         @set -e; rm -f $@; mkdir -p $$(dirname $@) ; \
 217         $(CXX) -M $(CPPFLAGS) $(FINAL_CXXFLAGS) $< > $@.$$$$ 2>/dev/null ; \
 218         sed 's,'$$(basename $*)'\.o[ :]*,$*.o $@ : ,g' < $@.$$$$ > $@; \
 219         rm -f $@.$$$$
 220
 221 DEPS := $(SRCS:%.c=.deps/%.d)
 222 DEPS := $(DEPS:%.cc=.deps/%.d)
 223 -include $(DEPS)
 224
 225 .PHONY : clean
 226 clean:
 227         rm -f $(CLEAN); rm -rf .deps
 228
 229 # We don't (yet) have any distributed files not in the upstream repository.
 230 # So distclean is currently identical to clean.
 231 .PHONY: distclean
 232 distclean: clean
 233
 234 notmuch_client_srcs =           \
 235         debugger.c              \
 236         gmime-filter-reply.c    \
 237         gmime-filter-headers.c  \
 238         notmuch.c               \
 239         notmuch-config.c        \
 240         notmuch-count.c         \
 241         notmuch-dump.c          \
 242         notmuch-new.c           \
 243         notmuch-reply.c         \
 244         notmuch-restore.c       \
 245         notmuch-search.c        \
 246         notmuch-search-tags.c   \
 247         notmuch-setup.c         \
 248         notmuch-show.c          \
 249         notmuch-tag.c           \
 250         notmuch-time.c          \
 251         query-string.c          \
 252         show-message.c          \
 253         json.c
 254
 255 notmuch_client_modules = $(notmuch_client_srcs:.c=.o)
 256
 257 notmuch: $(notmuch_client_modules) lib/libnotmuch.a
 258         $(call quiet,CXX $(CFLAGS)) $^ $(FINAL_LIBNOTMUCH_LDFLAGS) -o $@
 259
 260 notmuch-shared: $(notmuch_client_modules) lib/$(LINKER_NAME)
 261         $(call quiet,$(FINAL_NOTMUCH_LINKER) $(CFLAGS)) $(notmuch_client_modules) $(FINAL_NOTMUCH_LDFLAGS) -o $@
 262
 263 notmuch.1.gz: notmuch.1
 264         gzip --stdout $^ > $@
 265
 266 .PHONY: install
 267 install: all notmuch.1.gz
 268         mkdir -p $(DESTDIR)$(mandir)/man1
 269         install -m0644 notmuch.1.gz $(DESTDIR)$(mandir)/man1/
 270         mkdir -p $(DESTDIR)$(prefix)/bin/
 271         install notmuch-shared $(DESTDIR)$(prefix)/bin/notmuch
 272 ifeq ($(MAKECMDGOALS), install)
 273         @echo ""
 274         @echo "Notmuch is now installed to $(DESTDIR)$(prefix)"
 275         @echo ""
 276         @echo "To run notmuch from emacs, each user should add the following line to ~/.emacs:"
 277         @echo ""
 278         @echo " (require 'notmuch)"
 279         @echo ""
 280         @echo "And should then run \"M-x notmuch\" from within emacs or run \"emacs -f notmuch\""
 281 endif
 282
 283 .PHONY: install-desktop
 284 install-desktop:
 285         mkdir -p $(DESTDIR)$(desktop_dir)
 286         desktop-file-install --mode 0644 --dir $(DESTDIR)$(desktop_dir) notmuch.desktop
 287
 288 SRCS  := $(SRCS) $(notmuch_client_srcs)
 289 CLEAN := $(CLEAN) notmuch notmuch-shared $(notmuch_client_modules) notmuch.elc notmuch.1.gz