Use git_commit to ensure that a committer ident is defined
[tig.git] / Makefile
blob2cb99968e7dd8ddcd1202225dc22ffdfe9461adb
1 ## Makefile for tig
3 # The last tagged version. Can be overridden either by the version from
4 # git or from the value of the DIST_VERSION environment variable.
5 VERSION = 2.1.1
7 all:
9 # Include kernel specific configuration
10 kernel_name := $(shell sh -c 'uname -s 2>/dev/null || echo unknown')
11 -include contrib/config.make-$(kernel_name)
13 # Include setting from the configure script
14 -include config.make
16 # Optional defaults.
17 # TIG_ variables are set by contrib/config.make-$(kernel_name).
18 TIG_NCURSES ?= -lcurses
19 LDFLAGS ?= $(TIG_LDFLAGS)
20 CPPFLAGS ?= $(TIG_CPPFLAGS)
21 LDLIBS ?= $(TIG_NCURSES) $(TIG_LDLIBS)
22 CFLAGS ?= -Wall -O2 $(TIG_CFLAGS)
24 prefix ?= $(HOME)
25 bindir ?= $(prefix)/bin
26 datarootdir ?= $(prefix)/share
27 sysconfdir ?= $(prefix)/etc
28 docdir ?= $(datarootdir)/doc
29 mandir ?= $(datarootdir)/man
30 # DESTDIR=
32 ifneq (,$(wildcard .git))
33 GITDESC = $(subst tig-,,$(shell git describe 2>/dev/null))
34 COMMIT := $(if $(GITDESC),$(GITDESC),$(VERSION)-g$(shell git describe --always))
35 WTDIRTY = $(if $(shell git diff-index HEAD 2>/dev/null),-dirty)
36 VERSION = $(COMMIT)$(WTDIRTY)
37 endif
38 ifdef DIST_VERSION
39 VERSION = $(DIST_VERSION)
40 endif
42 # Split the version "TAG-OFFSET-gSHA1-DIRTY" into "TAG OFFSET"
43 # and append 0 as a fallback offset for "exact" tagged versions.
44 RPM_VERLIST = $(filter-out g% dirty,$(subst -, ,$(VERSION))) 0
45 RPM_VERSION = $(word 1,$(RPM_VERLIST))
46 RPM_RELEASE = $(word 2,$(RPM_VERLIST))$(if $(WTDIRTY),.dirty)
48 DFLAGS = -g -DDEBUG -Werror -O0
49 EXE = src/tig
50 TOOLS = test/tools/test-graph tools/doc-gen
51 TXTDOC = doc/tig.1.adoc doc/tigrc.5.adoc doc/manual.adoc NEWS.adoc README.adoc INSTALL.adoc
52 MANDOC = doc/tig.1 doc/tigrc.5 doc/tigmanual.7
53 HTMLDOC = doc/tig.1.html doc/tigrc.5.html doc/manual.html README.html INSTALL.html NEWS.html
54 ALLDOC = $(MANDOC) $(HTMLDOC) doc/manual.html-chunked doc/manual.pdf
56 # Never include the release number in the tarname for tagged
57 # versions.
58 ifneq ($(if $(DIST_VERSION),$(words $(RPM_VERLIST))),2)
59 TARNAME = tig-$(RPM_VERSION)-$(RPM_RELEASE)
60 else
61 TARNAME = tig-$(RPM_VERSION)
62 endif
64 override CPPFLAGS += '-DTIG_VERSION="$(VERSION)"'
65 override CPPFLAGS += '-DSYSCONFDIR="$(sysconfdir)"'
67 ASCIIDOC ?= asciidoc
68 ASCIIDOC_FLAGS = -aversion=$(VERSION) -asysconfdir=$(sysconfdir) -f doc/asciidoc.conf
69 XMLTO ?= xmlto
70 DOCBOOK2PDF ?= docbook2pdf
72 LCOV ?= lcov
73 GENHTML ?= genhtml
75 all: $(EXE) $(TOOLS)
76 all-debug: all
77 all-debug: CFLAGS += $(DFLAGS)
78 doc: $(ALLDOC)
79 doc-man: $(MANDOC)
80 doc-html: $(HTMLDOC)
82 export sysconfdir
84 install: all
85 $(QUIET_INSTALL)tools/install.sh bin $(EXE) "$(DESTDIR)$(bindir)"
86 $(QUIET_INSTALL)tools/install.sh data tigrc "$(DESTDIR)$(sysconfdir)"
88 install-doc-man: doc-man
89 $(Q)$(foreach doc, $(filter %.1, $(MANDOC)), \
90 $(QUIET_INSTALL_EACH)tools/install.sh data $(doc) "$(DESTDIR)$(mandir)/man1";)
91 $(Q)$(foreach doc, $(filter %.5, $(MANDOC)), \
92 $(QUIET_INSTALL_EACH)tools/install.sh data $(doc) "$(DESTDIR)$(mandir)/man5";)
93 $(Q)$(foreach doc, $(filter %.7, $(MANDOC)), \
94 $(QUIET_INSTALL_EACH)tools/install.sh data $(doc) "$(DESTDIR)$(mandir)/man7";)
96 install-release-doc-man:
97 GIT_INDEX_FILE=.tmp-doc-index git read-tree origin/release
98 GIT_INDEX_FILE=.tmp-doc-index git checkout-index -f --prefix=./ $(MANDOC)
99 rm -f .tmp-doc-index
100 $(MAKE) install-doc-man
102 install-doc-html: doc-html
103 $(Q)$(foreach doc, $(HTMLDOC), \
104 $(QUIET_INSTALL_EACH)tools/install.sh data $(doc) "$(DESTDIR)$(docdir)/tig";)
106 install-release-doc-html:
107 GIT_INDEX_FILE=.tmp-doc-index git read-tree origin/release
108 GIT_INDEX_FILE=.tmp-doc-index git checkout-index -f --prefix=./ $(HTMLDOC)
109 rm -f .tmp-doc-index
110 $(MAKE) install-doc-html
112 install-doc: install-doc-man install-doc-html
113 install-release-doc: install-release-doc-man install-release-doc-html
115 clean: clean-test clean-coverage
116 $(Q)$(RM) -r $(TARNAME) *.spec tig-*.tar.gz tig-*.tar.gz.md5 .deps
117 $(Q)$(RM) $(EXE) $(TOOLS) $(OBJS) core doc/*.xml src/builtin-config.c
118 $(Q)$(RM) $(OBJS:%.o=%.gcda) $(OBJS:%.o=%.gcno)
120 distclean: clean
121 $(RM) -r doc/manual.html-chunked autom4te.cache release-docs
122 $(RM) doc/*.toc $(ALLDOC) aclocal.m4 configure
123 $(RM) config.h config.log config.make config.status config.h.in
125 spell-check:
126 for file in $(TXTDOC) src/tig.c; do \
127 aspell --lang=en --dont-backup \
128 --personal=./tools/aspell.dict check $$file; \
129 done
131 strip: $(EXE)
132 strip $(EXE)
134 update-headers:
135 @for file in include/tig/*.h src/*.c tools/*.c test/tools/*.c; do \
136 grep -q '/* Copyright' "$$file" && \
137 sed '0,/.*\*\//d' < "$$file" | \
138 grep -v '/* vim: set' > "$$file.tmp"; \
139 { cat tools/header.h "$$file.tmp"; \
140 echo "/* vim: set ts=8 sw=8 noexpandtab: */"; } > "$$file"; \
141 rm "$$file.tmp"; \
142 echo "Updated $$file"; \
143 done
145 update-docs: tools/doc-gen
146 doc="doc/tigrc.5.adoc"; \
147 sed -n '0,/ifndef::DOC_GEN_ACTIONS/p' < "$$doc" > "$$doc.gen"; \
148 ./tools/doc-gen actions >> "$$doc.gen"; \
149 sed -n '/endif::DOC_GEN_ACTIONS/,$$p' < "$$doc" >> "$$doc.gen" ; \
150 mv "$$doc.gen" "$$doc"
152 dist: configure tig.spec
153 $(Q)mkdir -p $(TARNAME) && \
154 cp Makefile tig.spec configure config.h.in aclocal.m4 $(TARNAME) && \
155 sed -i "s/VERSION\s\+=\s\+[0-9]\+\([.][0-9]\+\)\+/VERSION = $(VERSION)/" $(TARNAME)/Makefile
156 git archive --format=tar --prefix=$(TARNAME)/ HEAD | \
157 tar --delete $(TARNAME)/Makefile > $(TARNAME).tar && \
158 tar rf $(TARNAME).tar `find $(TARNAME)/*` && \
159 gzip -f -9 $(TARNAME).tar && \
160 md5sum $(TARNAME).tar.gz > $(TARNAME).tar.gz.md5
161 $(Q)$(RM) -r $(TARNAME)
163 rpm: dist
164 rpmbuild -ta $(TARNAME).tar.gz
166 COVERAGE_CFLAGS ?= -fprofile-arcs -ftest-coverage
167 all-coverage: all
168 all-coverage: CFLAGS += $(COVERAGE_CFLAGS)
170 COVERAGE_DIR ?= test/coverage
172 clean-coverage:
173 @$(RM) -rf $(COVERAGE_DIR)
175 reset-coverage: clean-coverage
176 $(LCOV) --reset-counters
178 test-coverage: clean-coverage all-coverage test $(COVERAGE_DIR)/index.html
180 $(COVERAGE_DIR)/trace:
181 @mkdir -p $(COVERAGE_DIR)
182 $(QUIET_LCOV)$(LCOV) $(Q:@=--quiet) --capture --no-external --directory . --output-file $@
184 $(COVERAGE_DIR)/index.html: $(COVERAGE_DIR)/trace
185 $(QUIET_GENHTML)$(GENHTML) $(Q:@=--quiet) --output-directory $(COVERAGE_DIR) $<
187 TESTS = $(sort $(shell find test -type f -name '*-test'))
189 clean-test:
190 $(Q)$(RM) -r test/tmp
192 test: clean-test $(TESTS)
193 $(QUIET_SUMMARY)test/tools/show-results.sh
195 export TIG_TEST_OPTS = $(V:1=no-indent)
197 $(TESTS): PATH := $(CURDIR)/test/tools:$(CURDIR)/src:$(PATH)
198 $(TESTS): $(EXE) test/tools/test-graph
199 $(QUIET_TEST)$(TEST_SHELL) $@
201 # Other autoconf-related rules are hidden in config.make.in so that
202 # they don't confuse Make when we aren't actually using ./configure
203 configure: configure.ac acinclude.m4 tools/*.m4
204 ./autogen.sh
206 .PHONY: all all-coverage all-debug clean clean-coverage clean-test doc \
207 doc-man doc-html dist distclean install install-doc \
208 install-doc-man install-doc-html install-release-doc-html \
209 install-release-doc-man rpm spell-check strip test \
210 test-coverage update-docs update-headers $(TESTS)
212 ifdef NO_MKSTEMPS
213 COMPAT_CPPFLAGS += -DNO_MKSTEMPS
214 COMPAT_OBJS += compat/mkstemps.o
215 endif
217 ifdef NO_SETENV
218 COMPAT_CPPFLAGS += -DNO_SETENV
219 COMPAT_OBJS += compat/setenv.o
220 endif
222 ifdef NO_STRNDUP
223 COMPAT_CPPFLAGS += -DNO_STRNDUP
224 COMPAT_OBJS += compat/strndup.o
225 endif
227 COMPAT_OBJS += compat/hashtab.o
229 override CPPFLAGS += $(COMPAT_CPPFLAGS)
231 GRAPH_OBJS = src/graph.o src/graph-v1.o src/graph-v2.o
233 TIG_OBJS = \
234 src/tig.o \
235 src/types.o \
236 src/string.o \
237 src/util.o \
238 src/map.o \
239 src/argv.o \
240 src/io.o \
241 src/refdb.o \
242 src/builtin-config.o \
243 src/request.o \
244 src/line.o \
245 src/keys.o \
246 src/repo.o \
247 src/options.o \
248 src/draw.o \
249 src/prompt.o \
250 src/display.o \
251 src/view.o \
252 src/parse.o \
253 src/watch.o \
254 src/pager.o \
255 src/log.o \
256 src/diff.o \
257 src/help.o \
258 src/tree.o \
259 src/blob.o \
260 src/blame.o \
261 src/refs.o \
262 src/status.o \
263 src/stage.o \
264 src/main.o \
265 src/stash.o \
266 src/grep.o \
267 src/ui.o \
268 $(GRAPH_OBJS) \
269 $(COMPAT_OBJS)
271 src/tig: $(TIG_OBJS)
273 TEST_GRAPH_OBJS = test/tools/test-graph.o src/string.o src/util.o src/io.o $(GRAPH_OBJS) $(COMPAT_OBJS)
274 test/tools/test-graph: $(TEST_GRAPH_OBJS)
276 DOC_GEN_OBJS = tools/doc-gen.o src/string.o src/types.o src/util.o src/request.o
277 tools/doc-gen: $(DOC_GEN_OBJS)
279 OBJS = $(sort $(TIG_OBJS) $(TEST_GRAPH_OBJS) $(DOC_GEN_OBJS))
281 DEPS_CFLAGS ?= -MMD -MP -MF .deps/$*.d
283 %: %.o
284 $(QUIET_LINK)$(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
286 %.o: %.c $(CONFIG_H)
287 @mkdir -p .deps/$(*D)
288 $(QUIET_CC)$(CC) -I. -Iinclude $(CFLAGS) $(DEPS_CFLAGS) $(CPPFLAGS) -c -o $@ $<
290 -include $(OBJS:%.o=.deps/%.d)
292 src/builtin-config.c: tigrc tools/make-builtin-config.sh
293 $(QUIET_GEN)tools/make-builtin-config.sh $< > $@
295 tig.spec: contrib/tig.spec.in
296 $(QUIET_GEN)sed -e 's/@@VERSION@@/$(RPM_VERSION)/g' \
297 -e 's/@@RELEASE@@/$(RPM_RELEASE)/g' < $< > $@
299 doc/manual.html: doc/manual.toc
300 doc/manual.html: ASCIIDOC_FLAGS += -ainclude-manual-toc
301 %.toc: %.adoc
302 $(QUIET_GEN)sed -n '/^\[\[/,/\(---\|~~~\)/p' < $< | while read line; do \
303 case "$$line" in \
304 "----"*) echo ". <<$$ref>>"; ref= ;; \
305 "~~~~"*) echo "- <<$$ref>>"; ref= ;; \
306 "[["*"]]") ref="$$line" ;; \
307 *) ref="$$ref, $$line" ;; \
308 esac; done | sed 's/\[\[\(.*\)\]\]/\1/' > $@
310 README.html: README.adoc doc/asciidoc.conf
311 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article -a readme $<
313 INSTALL.html: INSTALL.adoc doc/asciidoc.conf
314 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article $<
316 NEWS.html: NEWS.adoc doc/asciidoc.conf
317 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article $<
319 doc/tigmanual.7: doc/manual.adoc
321 %.1.html : %.1.adoc doc/asciidoc.conf
322 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d manpage $<
324 %.1.xml : %.1.adoc doc/asciidoc.conf
325 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d manpage $<
327 %.5.html : %.5.adoc doc/asciidoc.conf
328 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d manpage $<
330 %.5.xml : %.5.adoc doc/asciidoc.conf
331 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d manpage $<
333 %.7.xml : %.7.adoc doc/asciidoc.conf
334 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d manpage $<
336 %.html: ASCIIDOC_FLAGS += -adocext=html
337 %.html : %.adoc doc/asciidoc.conf
338 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article -n $<
340 %.xml : %.adoc doc/asciidoc.conf
341 $(QUIET_ASCIIDOC)$(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d article $<
343 % : %.xml
344 $(QUIET_XMLTO)$(XMLTO) man -o doc $<
346 %.html-chunked : %.xml
347 $(QUIET_XMLTO)$(XMLTO) html -o $@ $<
349 %.pdf : %.xml
350 $(QUIET_DB2PDF)$(DOCBOOK2PDF) -o doc $<
352 #############################################################################
353 # Quiet make
354 #############################################################################
356 ifneq ($(findstring $(MAKEFLAGS),s),s)
357 V = @
358 Q = $(V:1=)
359 QUIET_CC = $(Q:@=@echo ' CC '$@;)
360 QUIET_LINK = $(Q:@=@echo ' LINK '$@;)
361 QUIET_GEN = $(Q:@=@echo ' GEN '$@;)
362 QUIET_ASCIIDOC = $(Q:@=@echo ' ASCIIDOC '$@;)
363 QUIET_XMLTO = $(Q:@=@echo ' XMLTO '$@;)
364 QUIET_DB2PDF = $(Q:@=@echo ' DB2PDF '$@;)
365 # tools/install.sh will print 'file -> $install_dir/file'
366 QUIET_INSTALL = $(Q:@=@printf ' INSTALL ';)
367 QUIET_INSTALL_EACH = $(Q:@=printf ' INSTALL ';)
368 QUIET_TEST = $(Q:@=@echo ' TEST '$@;)
369 QUIET_SUMMARY = $(Q:@=@printf ' SUMMARY ';)
370 QUIET_LCOV = $(Q:@=@echo ' LCOV '$@;)
371 QUIET_GENHTML = $(Q:@=@echo ' GENHTML '$@;)
373 export V
374 endif