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 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 $(AS_NEEDED_LDFLAGS) $(GMIME_LDFLAGS) $(TALLOC_LDFLAGS)
  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 ($(LIBDIR_IN_LDCONFIG),0)
  41 FINAL_NOTMUCH_LDFLAGS += $(RPATH_LDFLAGS)
  42 endif
  43 FINAL_LIBNOTMUCH_LDFLAGS = $(LDFLAGS) $(AS_NEEDED_LDFLAGS) $(CONFIGURE_LDFLAGS)
  44
  45 .PHONY: all
  46 all: notmuch notmuch-shared notmuch.1.gz
  47 ifeq ($(MAKECMDGOALS),)
  48 ifeq ($(shell cat .first-build-message 2>/dev/null),)
  49         @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all
  50         @echo ""
  51         @echo "Compilation of notmuch is now complete. You can install notmuch with:"
  52         @echo ""
  53         @echo " make install"
  54         @echo ""
  55         @echo "Note that depending on the prefix to which you are installing"
  56         @echo "you may need root permission (such as \"sudo make install\")."
  57         @echo "See \"./configure --help\" for help on setting an alternate prefix."
  58         @echo Printed > .first-build-message
  59 endif
  60 endif
  61
  62 $(TAR_FILE):
  63         git archive --format=tar --prefix=$(PACKAGE)-$(VERSION)/ HEAD > $(TAR_FILE).tmp
  64         echo $(VERSION) > version.tmp
  65         tar --append -f $(TAR_FILE).tmp --transform s_^_$(PACKAGE)-$(VERSION)/_  --transform 's_.tmp$$__' version.tmp
  66         rm version.tmp
  67         gzip < $(TAR_FILE).tmp > $(TAR_FILE)
  68         @echo "Source is ready for release in $(TAR_FILE)"
  69
  70 $(SHA1_FILE): $(TAR_FILE)
  71         sha1sum $^ > $@
  72
  73 $(GPG_FILE): $(SHA1_FILE)
  74         @echo "Please enter your GPG password to sign the checksum."
  75         gpg --armor --sign $^
  76
  77 .PHONY: dist
  78 dist: $(TAR_FILE)
  79
  80 # We invoke make recursively only to force ordering of our phony
  81 # targets in the case of parallel invocation of make (-j).
  82 #
  83 # We carefully ensure that our VERSION variable is passed down to any
  84 # sub-ordinate make invocations (which won't otherwise know that they
  85 # are part of the release and need to take the version from the
  86 # version file).
  87 .PHONY: release
  88 release: verify-source-tree-and-version
  89         $(MAKE) VERSION=$(VERSION) verify-newer
  90         $(MAKE) VERSION=$(VERSION) clean
  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         @wget -q -O /dev/null $(RELEASE_URL)/$(TAR_FILE) ; \
 185         case $$? in \
 186           8) echo "Good." ;; \
 187           0) echo "Ouch."; \
 188              echo "Found: $(RELEASE_URL)/$(TAR_FILE)"; \
 189              echo "Refusing to replace an existing release."; \
 190              echo "Don't forget to update \"version\" as described in RELEASING before release." ; \
 191              false ;; \
 192           *) echo "An unexpected error occured"; \
 193              false;; esac
 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-setup.c         \
 252         notmuch-show.c          \
 253         notmuch-tag.c           \
 254         notmuch-time.c          \
 255         query-string.c          \
 256         show-message.c          \
 257         json.c                  \
 258         xutil.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 ifeq ($(WITH_EMACS), 1)
 286         @echo ""
 287         @echo "Beyond the command-line interface, notmuch also offers"
 288         @echo "a full-featured interface for reading and writing mail"
 289         @echo "within emacs. To use this, each user should add the"
 290         @echo "following line to the ~/.emacs file:"
 291         @echo ""
 292         @echo " (require 'notmuch)"
 293         @echo ""
 294         @echo "And then run emacs as \"emacs -f notmuch\" or invoke"
 295         @echo "the command \"M-x notmuch\" from within emacs."
 296 endif
 297 endif
 298
 299 .PHONY: install-desktop
 300 install-desktop:
 301         mkdir -p "$(DESTDIR)$(desktop_dir)"
 302         desktop-file-install --mode 0644 --dir "$(DESTDIR)$(desktop_dir)" notmuch.desktop
 303
 304 SRCS  := $(SRCS) $(notmuch_client_srcs)
 305 CLEAN := $(CLEAN) notmuch notmuch-shared $(notmuch_client_modules) notmuch.elc notmuch.1.gz