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