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