Make: Move .tarball-version generation out of src/scripts/tarball
[empserver] / Make.mk
1 #
2 #   Empire - A multi-player, client/server Internet based war game.
3 #   Copyright (C) 1986-2017, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 #                 Ken Stevens, Steve McClure, Markus Armbruster
5 #
6 #   Empire is free software: you can redistribute it and/or modify
7 #   it under the terms of the GNU General Public License as published by
8 #   the Free Software Foundation, either version 3 of the License, or
9 #   (at your option) any later version.
10 #
11 #   This program is distributed in the hope that it will be useful,
12 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #   GNU General Public License for more details.
15 #
16 #   You should have received a copy of the GNU General Public License
17 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19 #   ---
20 #
21 #   See files README, COPYING and CREDITS in the root of the source
22 #   tree for related information and legal notices.  It is expected
23 #   that future projects/authors will amend these files as needed.
24 #
25 #   ---
26 #
27 #   Make.mk: The real Makefile, included by GNUmakefile
28 #
29 #   Known contributors to this file:
30 #      Markus Armbruster, 2005-2017
31 #
32
33 # This makefile was inspired by `Recursive Make Considered Harmful',
34 # Peter Miller, 1997.
35 # http://miller.emu.id.au/pmiller/books/rmch/
36
37 # Recursively expanded variables are occasionally useful, but can be
38 # slow and tricky.  Do not use them gratuitously.  If you don't
39 # understand this, always use `:=' rather than `='.
40
41 # Default goal
42 all:
43
44 # Delete target on error.  Every Makefile should have this.
45 .DELETE_ON_ERROR:
46
47 # Source files
48 ifeq ($(revctrl),git)
49 src := $(shell cd $(srcdir) && git ls-files | uniq)
50 version := $(shell cd $(srcdir) && build-aux/git-version-gen /dev/null)
51 else
52 include $(srcdir)/sources.mk
53 version := $(shell cat $(srcdir)/.tarball-version || echo "UNKNOWN")
54 endif
55 ifeq ($(version),UNKNOWN)
56 $(error cannot figure out version)
57 endif
58 dirs := $(sort $(dir $(src)))
59 csrc := $(filter %.c, $(src))
60 tsrc := $(filter %.t, $(src))
61 man6 := $(filter man/%.6, $(src))
62 builtins := $(filter src/lib/global/%.config, $(src))
63
64 # Info subjects
65 include $(srcdir)/info/subjects.mk
66
67 # Abbreviations
68 topics := $(patsubst %.t,%,$(notdir $(tsrc)))
69 info := $(topics) $(subjects) all TOP
70 scripts := $(srcdir)/src/scripts
71 depcomp := $(SHELL) $(srcdir)/depcomp
72 tarball := $(SHELL) -e $(scripts)/tarball
73 econfig := $(sysconfdir)/empire/econfig
74 schedule := $(sysconfdir)/empire/schedule
75 gamedir := $(localstatedir)/empire
76 edatadir := $(datadir)/empire
77 builtindir := $(edatadir)/builtin
78 einfodir := $(edatadir)/info.nr
79 ehtmldir := $(edatadir)/info.html
80 client/w32 := arpa/inet.h netdb.h netinet/in.h sys/time.h sys/socket.h  \
81 sys/uio.h unistd.h w32io.c w32sockets.c w32types.h
82
83 # Abbreviate make output
84 # Run make with a V=1 parameter for full output.
85 ifneq ($(origin V),command line)
86 V:=
87 endif
88 # $(call quiet-command COMMAND,ABBREV) runs COMMAND, but prints only ABBREV.
89 # Recursively expanded so that variables in COMMAND and ABBREV work.
90 ifneq ($V$(findstring s,$(MAKEFLAGS)),)
91 quiet-command = $1
92 else
93 quiet-command = @echo $2 && $1
94 endif
95
96 # How to substitute Autoconf output variables
97 # Recursively expanded so that $@ and $< work.
98 subst.in = sed \
99         -e 's?@configure_input\@?$(notdir $@): Generated from $(notdir $<) by make.?g' \
100         -e 's?@builtindir\@?$(builtindir)?g'    \
101         -e 's?@econfig\@?$(econfig)?g'          \
102         -e 's?@einfodir\@?$(einfodir)?g'        \
103         -e 's?@gamedir\@?$(gamedir)?g'          \
104         -e 's/@EMPIREHOST\@/$(EMPIREHOST)/g'    \
105         -e 's/@EMPIREPORT\@/$(EMPIREPORT)/g'
106
107 # Generated files
108 # See `Cleanliness' below
109 # Generated makefiles, distributed by dist-source from $(srcdir):
110 mk := sources.mk
111 # Generated by Autoconf, not distributed:
112 ac := config.h config.log config.status info.html info.nr lib stamp-h
113 ac += $(basename $(filter %.in, $(src)))
114 ac += $(srcdir)/autom4te.cache $(srcdir)/src/client/autom4te.cache
115 # distributed by dist-source from $(srcdir):
116 acdist := aclocal.m4 config.h.in configure stamp-h.in
117 # distributed by dist-client from $(srcdir):
118 acdistcli := $(addprefix src/client/, aclocal.m4 config.h.in configure)
119 # Object files:
120 obj := $(csrc:.c=.o) $(filter %.o, $(ac:.c=.o))
121 # Dependencies:
122 deps := $(obj:.o=.d)
123 # Library archives:
124 libs := $(addprefix lib/, libcommon.a libgen.a libglobal.a)
125 # Programs:
126 util := $(addprefix src/util/, $(addsuffix $(EXEEXT), empdump empsched fairland files pconfig))
127 client := src/client/empire$(EXEEXT)
128 server := src/server/emp_server$(EXEEXT)
129 # Info subjects:
130 tsubj := $(addprefix info/, $(addsuffix .t, $(subjects)))
131 # Formatted info:
132 info.nr := $(addprefix info.nr/, $(info))
133 info.html := $(addprefix info.html/, $(addsuffix .html, $(info)))
134 info.all := $(info.nr) $(info.html) info.ps info/stamp-subj
135 # Tests
136 # sandbox
137
138 # Conditionally generated files:
139 empth_obj := src/lib/empthread/io.o
140 empth_lib :=
141 ifeq ($(empthread),LWP)
142 empth_obj += src/lib/empthread/lwp.o src/lib/empthread/posix.o
143 empth_lib += lib/liblwp.a
144 endif
145 ifeq ($(empthread),POSIX)
146 empth_obj += src/lib/empthread/pthread.o src/lib/empthread/posix.o
147 endif
148 ifeq ($(empthread),Windows)
149 empth_obj += src/lib/empthread/ntthread.o
150 endif
151
152 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
153 libs += lib/libw32.a
154 $(client): lib/libw32.a
155 endif
156
157 # Cleanliness
158 # Each generated file should be in one of the following sets.
159 # Removed by clean:
160 clean := $(obj) $(deps) $(libs) $(util) $(client) $(server) $(tsubj)    \
161 info/toc info/TOP.t $(info.all) $(empth_obj) $(empth_lib) sandbox
162 # Removed by distclean:
163 distclean := $(ac)
164 ifeq ($(revctrl),git)
165 distclean += $(addprefix $(srcdir)/, $(mk))
166 endif
167 # Distributed by dist-source from $(srcdir):
168 src_distgen := $(acdist) $(mk)
169 # Distributed by dist-client from $(srcdir)/src/client; removed by distclean:
170 cli_distgen := $(acdistcli)
171 distclean += $(addprefix $(srcdir)/, $(cli_distgen))
172
173 # Compiler flags
174 CPPFLAGS += -I$(srcdir)/include -I.
175 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
176 CPPFLAGS += -I$(srcdir)/src/lib/w32
177 endif
178 $(client): LDLIBS := $(LIBS_client)
179 $(server): LDLIBS := $(LIBS_server)
180
181
182 ### Advertized goals
183
184 .PHONY: all
185 all: $(util) $(client) $(server) info
186
187 .PHONY: info html
188 info: $(info.nr)
189 html: $(info.html)
190
191 .PHONY: clean
192 clean:
193         $(call quiet-command,rm -rf $(clean),CLEAN)
194
195 .PHONY: distclean
196 distclean: clean
197         $(call quiet-command,rm -rf $(distclean),DISTCLEAN)
198
199 .PHONY: install
200 install: all installdirs
201         $(INSTALL_PROGRAM) $(util) $(server) $(sbindir)
202         $(INSTALL_PROGRAM) $(client) $(bindir)
203         $(INSTALL) -m 444 $(addprefix $(srcdir)/, $(builtins)) $(builtindir)
204         rm -f $(einfodir)/*
205         $(INSTALL_DATA) $(info.nr) $(einfodir)
206         $(INSTALL_DATA) $(addprefix $(srcdir)/, $(man6)) $(mandir)/man6
207         sed -e '1,/^$$/d' -e 's/^/# /g' <$(srcdir)/doc/schedule >$(schedule).dist
208         echo >>$(schedule).dist
209         echo 'every 10 minutes' >>$(schedule).dist
210         [ -e $(schedule) ] || mv $(schedule).dist $(schedule)
211         if [ -e $(econfig) ]; then                                      \
212             echo "Attempting to update your econfig";                   \
213             if src/util/pconfig $(econfig) >$(econfig).dist; then       \
214                 if cmp -s $(econfig) $(econfig).dist; then              \
215                     echo "$(econfig) unchanged";                        \
216                     rm $(econfig).dist;                                 \
217                 fi;                                                     \
218             else                                                        \
219                 echo "Your $(econfig) doesn't work";                    \
220                 src/util/pconfig >$(econfig).dist;                      \
221             fi;                                                         \
222             if [ -e $(econfig).dist ]; then                             \
223                 echo "Check out $(econfig).dist";                       \
224             fi;                                                         \
225         else                                                            \
226             src/util/pconfig >$(econfig);                               \
227         fi
228
229 .PHONY: installdirs
230 installdirs:
231         mkdir -p $(sbindir) $(bindir) $(builtindir) $(einfodir) $(mandir)/man6 $(dir $(econfig)) $(gamedir)
232
233 .PHONY: install-html
234 install-html: html
235         mkdir -p $(ehtmldir)
236         rm -f $(ehtmldir)/*
237         $(INSTALL_DATA) $(info.html) $(ehtmldir)
238
239 .PHONY: uninstall
240 uninstall:
241         rm -f $(addprefix $(sbindir)/, $(notdir $(util) $(server)))
242         rm -f $(addprefix $(bindir)/, $(notdir $(client)))
243         rm -rf $(builtindir) $(einfodir) $(ehtmldir)
244         rmdir $(edatadir)
245         rm -f $(addprefix $(mandir)/man6/, $(notdir $(man6)))
246         @echo "$(dir $(econfig)) and $(gamedir) not removed, you may wish to remove it manually."
247
248 .PHONY: dist
249 dist: dist-source dist-client dist-info
250
251 .PHONY: check check-accept _check
252 check check-accept: _check
253 check:        export EMPIRE_CHECK_ACCEPT :=
254 check-accept: export EMPIRE_CHECK_ACCEPT := y
255 _check: all
256         @echo "Warning: test suite is immature and needs work." >&2
257         $(srcdir)/tests/files-test $(srcdir)
258         $(srcdir)/tests/fairland-test $(srcdir)
259         $(srcdir)/tests/info-test $(srcdir)
260 ifeq ($(empthread),LWP)
261         $(srcdir)/tests/smoke-test $(srcdir)
262         $(srcdir)/tests/actofgod-test $(srcdir)
263         $(srcdir)/tests/build-test $(srcdir)
264         $(srcdir)/tests/navi-march-test $(srcdir)
265         $(srcdir)/tests/fire-test $(srcdir)
266         $(srcdir)/tests/torpedo-test $(srcdir)
267         $(srcdir)/tests/bridgefall-test $(srcdir)
268         $(srcdir)/tests/retreat-test $(srcdir)
269         $(srcdir)/tests/update-test $(srcdir)
270         $(srcdir)/tests/version-test $(srcdir)
271 else
272         @echo "$(srcdir)/tests/smoke-test SKIPPED"
273         @echo "$(srcdir)/tests/actofgod-test SKIPPED"
274         @echo "$(srcdir)/tests/build-test SKIPPED"
275         @echo "$(srcdir)/tests/navi-march-test SKIPPED"
276         @echo "$(srcdir)/tests/fire-test SKIPPED"
277         @echo "$(srcdir)/tests/torpedo-test SKIPPED"
278         @echo "$(srcdir)/tests/bridgefall-test SKIPPED"
279         @echo "$(srcdir)/tests/retreat-test SKIPPED"
280         @echo "$(srcdir)/tests/update-test SKIPPED"
281         @echo "$(srcdir)/tests/version-test SKIPPED"
282 endif
283         $(srcdir)/tests/empdump-test $(srcdir)
284
285
286 ### Implicit rules
287
288 # Compile with dependencies as side effect, i.e. create %.d in
289 # addition to %.o.
290 ifeq ($(how_to_dep),fast)
291 %.o: %.c
292         $(call quiet-command,$(COMPILE.c) -MT $@ -MMD -MP -MF $(@:.o=.d) \
293         $(OUTPUT_OPTION) $< || { rm -f $(@:.o=.d) $@; false; },CC $@)
294 # Why the rm?  If gcc's preprocessor chokes, it leaves an empty
295 # dependency file behind, and doesn't touch the object file.  If an
296 # old object file exists, and is newer than the .c file, make will
297 # then consider the object file up-to-date.
298 endif
299 ifeq ($(how_to_dep),depcomp)
300 %.o: %.c
301         $(call quiet-command,source='$<' object='$@' depfile='$(@:.o=.d)' \
302         $(CCDEPMODE) $(depcomp) $(COMPILE.c) $(OUTPUT_OPTION) $<,CC $@)
303 endif
304 # Cancel the rule to compile %.c straight to %, it interferes with
305 # automatic dependency generation
306 %: %.c
307
308 %$(EXEEXT): %.o
309         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
310
311
312 info.nr/%: info/%.t
313         $(call quiet-command,$(NROFF) $(filter %.MAC, $^) $< | $(AWK) -f $(filter %/Blank.awk, $^) >$@ && test -s $@,NROFF $@)
314 # Pipes in make are a pain.  The "test -s" catches obvious errors.
315
316 info.html/%.html: info/%.t
317         $(call quiet-command,perl $(srcdir)/info/emp2html.pl $(info) <$< >$@,GEN $@)
318
319
320 ### Explicit rules
321
322 # Compilation
323
324 $(server): $(filter src/server/% src/lib/commands/% src/lib/player/% src/lib/subs/% src/lib/update/%, $(obj)) $(empth_obj) $(empth_lib) $(libs)
325         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
326
327 $(client): $(filter src/client/%, $(obj)) src/lib/global/version.o src/lib/gen/fnameat.o
328         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
329
330 $(util): $(libs)
331
332 lib/libcommon.a: $(filter src/lib/common/%, $(obj))
333 lib/libgen.a: $(filter src/lib/gen/%, $(obj))
334 lib/libglobal.a: $(filter src/lib/global/%, $(obj))
335 lib/liblwp.a: $(filter src/lib/lwp/%, $(obj))
336 lib/libw32.a: $(filter src/lib/w32/%, $(obj))
337
338 $(libs) $(empth_lib):
339         $(call quiet-command,$(AR) rc $@ $?,AR $@)
340         $(RANLIB) $@
341
342 src/lib/global/version.o: CPPFLAGS += -DVERSION='"$(version)"'
343 src/lib/global/version.o: $(src)
344
345 ifneq ($(revctrl),git)
346 $(srcdir)/.tarball-version: $(src)
347         v=`sed -e 's/-dirty$$//' <$@`; echo "$$v-dirty" >$@
348 # Force Make to start over after updating .tarball-version, so that
349 # $(version) gets the new value
350 $(srcdir)/.dirty-stamp: .tarball-version
351         >$@
352 include $(srcdir)/.dirty-stamp
353 endif
354
355 # Info formatting
356
357 # mksubj.pl reads $(tsrc) and writes $(tsubj).  A naive rule
358 #     $(tsubj): $(tsrc)
359 #           COMMAND
360 # runs COMMAND once for each target.  That's because multiple targets
361 # in an explicit rule is just a shorthand for one rule per target,
362 # each with the same prerequisites and commands.  Use a stamp file.
363 $(tsubj) info/toc: info/stamp-subj ;
364 info/stamp-subj: info/mksubj.pl $(tsrc)
365         $(call quiet-command,perl $(srcdir)/info/mksubj.pl $(subjects) $(filter %.t, $^),GEN '$(tsubj) info/toc')
366         >$@
367
368 info/TOP.t: info/mktop.pl info/subjects.mk
369         $(call quiet-command,perl $(srcdir)/info/mktop.pl $@ $(subjects),GEN $@)
370
371 info.nr/all: $(filter-out info.nr/all, $(info.nr))
372         >$@
373         (cd info.nr && LC_ALL=C ls -C $(info)) >>$@
374
375 info.html/all.html: info.nr/all info/ls2html.pl
376         expand $< | perl $(srcdir)/info/ls2html.pl >$@
377
378 $(info.nr): info/CRT.MAC info/INFO.MAC info/Blank.awk
379
380 $(info.html): info/emp2html.pl
381
382 info.ps: info/TROFF.MAC info/INFO.MAC info/TOP.t $(tsubj) $(tsrc)
383         groff $^ >$@
384
385 # Distributing
386
387 .PHONY: dist-source
388 dist-source: $(addprefix $(srcdir)/, $(src_distgen))
389         $(tarball) -x $(srcdir)/src/scripts/gen-tarball-version $(TARNAME) $(version) -C $(srcdir) $(src_distgen) $(src)
390
391 ifeq ($(revctrl),git)
392 .PHONY: $(srcdir)/sources.mk
393 $(srcdir)/sources.mk:
394         $(call quiet-command,echo "src := $(src)" >$@,GEN $@)
395 endif
396
397 .PHONY: dist-client
398 dist-client: $(addprefix $(srcdir)/, $(cli_distgen))
399         $(tarball)  -x $(srcdir)/src/scripts/gen-tarball-version        \
400         $(TARNAME)-client $(version)                                    \
401         -C $(srcdir)/src/client                                         \
402                 $(notdir $(filter src/client/%, $(src)) $(cli_distgen)) \
403         -C $(srcdir)/include fnameat.h proto.h version.h                \
404         -C $(srcdir)/src/lib/global version.c                           \
405         -C $(srcdir)/src/lib/gen fnameat.c                              \
406         -C $(srcdir)/src/lib $(addprefix w32/, $(client/w32))           \
407         -C $(srcdir)/man empire.6                                       \
408         -C $(srcdir)/build-aux install-sh                               \
409         -C $(srcdir) COPYING INSTALL
410
411 .PHONY: dist-info
412 dist-info: info html
413         $(tarball) $(TARNAME)-info-text $(version) -C info.nr $(info)
414         $(tarball) $(TARNAME)-info-html $(version) -C info.html $(addsuffix .html, $(info))
415
416 # Dependencies
417
418 ifneq ($(deps),)
419 -include $(deps)
420 endif
421
422
423 # Automatic remake of configuration
424 # See (autoconf)Automatic Remaking.
425 # This requires sufficiently recent versions of autoconf and automake
426
427 $(srcdir)/configure: configure.ac aclocal.m4
428         cd $(srcdir) && autoconf
429
430 # autoheader might not change config.h.in, so touch a stamp file.
431 $(srcdir)/config.h.in: stamp-h.in ;
432 $(srcdir)/stamp-h.in: configure.ac aclocal.m4
433         cd $(srcdir) && autoheader
434         touch $@
435
436 $(srcdir)/aclocal.m4: $(filter m4/%.m4, $(src))
437         cd $(srcdir) && aclocal -I m4
438
439 # config.status might not change config.h; use the stamp file.
440 config.h: stamp-h ;
441 stamp-h: config.h.in config.status
442         ./config.status config.h stamp-h
443
444 GNUmakefile: GNUmakefile.in config.status
445         ./config.status $@
446
447 config.status: configure
448         ./config.status --recheck
449
450 src/lib/global/path.c src/client/ipglob.c: %: %.in GNUmakefile Make.mk
451         $(call quiet-command,$(subst.in) <$< >$@,GEN $@)
452
453
454 # Make files for standalone client distribution
455
456 $(srcdir)/src/client/configure: src/client/configure.ac src/client/aclocal.m4
457         cd $(dir $@) && autoconf
458
459 $(srcdir)/src/client/config.h.in: src/client/configure.ac src/client/aclocal.m4
460         cd $(dir $@) && autoheader
461         touch $@
462
463 $(srcdir)/src/client/aclocal.m4: m4/ax_lib_socket_nsl.m4 m4/my_lib_readline.m4 m4/my_terminfo.m4 m4/my_windows_api.m4
464         cat $^ >$@