improve makefile

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 111 insertions, 53 deletions

diff --git a/Makefile b/Makefile
index 48ac92d..4186df9 100644
--- a/Makefile
+++ b/Makefile
@@ -4,79 +4,112 @@
 # without any warranty.
 
 
+# The package path prefix, if you want to install to another root, set DESTDIR to that root
 PREFIX ?= /usr
+# The command path excluding prefix
 BIN ?= /bin
+# The library path excluding prefix
 LIB ?= /lib
+# The executable library path excluding prefix
 LIBEXEC ?= /libexec
+# The resource path excluding prefix
 DATA ?= /share
+# The command path including prefix
 BINDIR ?= $(PREFIX)$(BIN)
+# The library path including prefix
 LIBDIR ?= $(PREFIX)$(LIB)
+# The executable library path including prefix
 LIBEXECDIR ?= $(PREFIX)$(LIBEXEC)
+# The resource path including prefix
 DATADIR ?= $(PREFIX)$(DATA)
+# The generic documentation path including prefix
 DOCDIR ?= $(DATADIR)/doc
-LICENSEDIR ?= $(DATADIR)/licenses
+# The info manual documentation path including prefix
 INFODIR ?= $(DATADIR)/info
+# The license base path including prefix
+LICENSEDIR ?= $(DATADIR)/licenses
 
+# Python 3 command to use in shebangs
 SHEBANG ?= /usr/bin/env python3
+# The name of the command as it should be installed
 COMMAND ?= blueshift
+# The name of the package as it should be installed
 PKGNAME ?= blueshift
 
+# Bindings for display server access
 SERVER_BINDINGS ?= randr vidmode
+# Executable bindings for display server access
+EXECS ?= idcrtc
 
-
+# Executable library files
+EXECLIBS = $(foreach E,$(EXECS),blueshift_$(E))
+# The installed pkg-config command
 PKGCONFIG ?= pkg-config
+# Optimisation settings for C code compilation
 OPTIMISE ?= -Og -g
+# Warnings settings for C code compilation
 WARN = -Wall -Wextra -pedantic
+# The C standard for C code compilation
+STD = c99
+LIBS_idcrtc = xcb-randr
 LIBS_randr = xcb-randr
 LIBS_vidmode = x11 xxf86vm
-LIBS = python3 $(foreach B,$(SERVER_BINDINGS),$(LIBS_$(B)))
-STD = c99
-FLAGS = $$($(PKGCONFIG) --cflags --libs $(LIBS)) -std=$(STD) $(WARN) $(OPTIMISE) -fPIC
-# TODO  only link to used libs for each binary
+LIBS = python3 $(foreach B,$(SERVER_BINDINGS) $(EXECS),$(LIBS_$(B)))
+FLAGS = $$($(PKGCONFIG) --cflags $(LIBS)) -std=$(STD) $(WARN) $(OPTIMISE) -fPIC $(CFLAGS) $(LDFLAGS) $(CPPFLAGS)
 
+# Resource files
 DATAFILES = 2deg 10deg redshift redshift_old
+# Python source files
 PYFILES = __main__.py colour.py curve.py monitor.py solar.py icc.py
+# Library files
 CBINDINGS = $(foreach B,$(SERVER_BINDINGS),blueshift_$(B).so)
+# Configuration script example files
 EXAMPLES = comprehensive sleepmode
 
 
+# Build rules
+
 .PHONY: default
 default: command info shell
 
 .PHONY: all
 all: command doc shell
 
-.PHONY: doc
-doc: info pdf dvi ps
+.PHONY: command
+command: $(foreach C,$(CBINDINGS),bin/$(C)) $(foreach E,$(EXECLIBS),bin/$(E)) bin/blueshift
 
-.PHONY: info
-info: blueshift.info
 
-.PHONY: pdf
-pdf: blueshift.pdf
+# Build rules for C source files
 
-.PHONY: dvi
-dvi: blueshift.dvi
+bin/blueshift_idcrtc: LIBS_=LIBS_idcrtc
+bin/blueshift_idcrtc: obj/blueshift_idcrtc.o
+	@mkdir -p bin
+	$(CC) $(FLAGS) $$($(PKGCONFIG) --libs $($(LIBS_))) -o $@ $^
 
-.PHONY: ps
-ps: blueshift.ps
+bin/blueshift_randr.so: LIBS_=LIBS_randr
+bin/blueshift_vidmode.so: LIBS_=LIBS_vidmode
+bin/%.so: obj/%.o obj/%_c.o
+	@mkdir -p bin
+	$(CC) $(FLAGS) $$($(PKGCONFIG) --libs $($(LIBS_))) -shared -o $@ $^
 
-.PHONY: command
-command: $(foreach C,$(CBINDINGS),bin/$(C)) bin/blueshift_idcrtc bin/blueshift
-# TODO  make bin/blueshift_idcrtc optional
+obj/%.o: src/%.c
+	@mkdir -p obj
+	$(CC) $(FLAGS) -c -o $@ $<
 
-.PHONY: shell
-shell: bash zsh fish
+obj/%.o: obj/%.c
+	@mkdir -p obj
+	$(CC) $(FLAGS) -c -o $@ $<
 
-.PHONY: bash
-bash: bin/blueshift.bash
 
-.PHONY: zsh
-zsh: bin/blueshift.zsh
+# Build rules for Cython source files
+
+obj/%.c: src/%.pyx
+	@mkdir -p obj
+	if ! cython -3 -v $<; then src/$*.c ; false ; fi
+	mv src/$*.c $@
 
-.PHONY: fish
-fish: bin/blueshift.fish
 
+# Build rules for Python source files
 
 bin/blueshift: obj/blueshift.zip
 	echo '#!/usr/bin/python3' > $@
@@ -94,60 +127,63 @@ obj/%.py: src/%.py
 	sed -i '/^LIBEXECDIR *= /s#^.*$$#LIBEXECDIR = '\''$(LIBEXECDIR)'\''#' $@
 
 
-bin/blueshift_idcrtc: obj/blueshift_idcrtc.o
-	@mkdir -p bin
-	$(CC) $(FLAGS) -o $@ $^
-
-bin/%.so: obj/%.o obj/%_c.o
-	@mkdir -p bin
-	$(CC) $(FLAGS) -shared -o $@ $^
-
-obj/%.o: src/%.c
-	@mkdir -p obj
-	$(CC) $(FLAGS) -c -o $@ $<
-
-obj/%.o: obj/%.c
-	@mkdir -p obj
-	$(CC) $(FLAGS) -c -o $@ $<
-
-obj/%.c: src/%.pyx
-	@mkdir -p obj
-	if ! cython -3 -v $<; then src/$*.c ; false ; fi
-	mv src/$*.c $@
+# Build rules for documentation
 
+.PHONY: doc
+doc: info pdf dvi ps
 
+.PHONY: info
+info: blueshift.info
 %.info: info/%.texinfo
 	makeinfo "$<"
 
+.PHONY: pdf
+pdf: blueshift.pdf
 %.pdf: info/%.texinfo
 	@mkdir -p obj
 	cd obj ; yes X | texi2pdf ../$<
 	mv obj/$@ $@
 
+.PHONY: dvi
+dvi: blueshift.dvi
 %.dvi: info/%.texinfo
 	@mkdir -p obj
 	cd obj ; yes X | $(TEXI2DVI) ../$<
 	mv obj/$@ $@
 
+.PHONY: ps
+ps: blueshift.ps
 %.ps: info/%.texinfo
 	@mkdir -p obj
 	cd obj ; yes X | texi2pdf --ps ../$<
 	mv obj/$@ $@
 
 
+# Build rules for shell auto-completion
+
+.PHONY: shell
+shell: bash zsh fish
+
+.PHONY: bash
+bash: bin/blueshift.bash
 bin/blueshift.bash: src/completion
 	@mkdir -p bin
 	auto-auto-complete bash --output $@ --source $<
 
+.PHONY: zsh
+zsh: bin/blueshift.zsh
 bin/blueshift.zsh: src/completion
 	@mkdir -p bin
 	auto-auto-complete zsh --output $@ --source $<
 
+.PHONY: fish
+fish: bin/blueshift.fish
 bin/blueshift.fish: src/completion
 	@mkdir -p bin
 	auto-auto-complete fish --output $@ --source $<
 
 
+# Install rules
 
 .PHONY: install
 install: install-base install-info install-examples install-shell
@@ -155,25 +191,41 @@ install: install-base install-info install-examples install-shell
 .PHONY: install
 install-all: install-base install-doc install-shell
 
+# Install base rules
+
 .PHONY: install-base
 install-base: install-command install-license
 
 .PHONY: install-command
-install-command: $(foreach C,$(CBINDINGS),bin/$(C)) bin/blueshift $(foreach D,$(DATAFILES),res/$(D))
+install-command: install-command-bin install-command-lib install-command-libexec install-command-share
+
+.PHONY: install-command-bin
+install-command-bin: bin/blueshift
 	install -dm755 -- "$(DESTDIR)$(BINDIR)"
-	install -m755 bin/blueshift -- "$(DESTDIR)$(BINDIR)/$(COMMAND)"
+	install -m755 $< -- "$(DESTDIR)$(BINDIR)/$(COMMAND)"
+
+.PHONY: install-command-lib
+install-command-lib: $(foreach C,$(CBINDINGS),bin/$(C))
 	install -dm755 -- "$(DESTDIR)$(LIBDIR)"
-	install -m755 $(foreach C,$(CBINDINGS),bin/$(C)) -- "$(DESTDIR)$(LIBDIR)"
+	install -m755 $^ -- "$(DESTDIR)$(LIBDIR)"
+
+.PHONY: install-command-libexec
+install-command-libexec: $(foreach E,$(EXECLIBS),bin/$(E))
 	install -dm755 -- "$(DESTDIR)$(LIBEXECDIR)"
-	install -m755 bin/blueshift_idcrtc -- "$(DESTDIR)$(LIBEXECDIR)/blueshift_idcrtc"
+	install -m755 $^ -- "$(DESTDIR)$(LIBEXECDIR)"
+
+.PHONY: install-command-share
+install-command-share: $(foreach D,$(DATAFILES),res/$(D))
 	install -dm755 -- "$(DESTDIR)$(DATADIR)/$(PKGNAME)"
-	install -m644 -- $(foreach D,$(DATAFILES),res/$(D)) "$(DESTDIR)$(DATADIR)/$(PKGNAME)"
+	install -m644 -- $^ "$(DESTDIR)$(DATADIR)/$(PKGNAME)"
 
 .PHONY: install-license
 install-license:
 	install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)"
 	install -m644 COPYING LICENSE -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)"
 
+# Install documentation
+
 .PHONY: install-doc
 install-doc: install-info install-pdf install-ps install-dvi install-examples
 
@@ -202,6 +254,8 @@ install-dvi: blueshift.dvi
 	install -dm755 -- "$(DESTDIR)$(DOCDIR)"
 	install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi"
 
+# Install shell auto-completion
+
 .PHONY: install-shell
 install-shell: install-bash install-zsh install-fish
 
@@ -221,11 +275,13 @@ install-fish: bin/blueshift.fish
 	install -m644 $< -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish"
 
 
+# Uninstall rules
+
 .PHONY: uninstall
 uninstall:
 	-rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)"
 	-rm -- $(foreach C,$(CBINDINGS),"$(DESTDIR)$(LIBDIR)/$(C)")
-	-rm -- "$(DESTDIR)$(LIBEXECDIR)/blueshift_idcrtc"
+	-rm -- $(foreach E,$(EXECLIBS),"$(DESTDIR)$(LIBEXECDIR)/$(E)")
 	-rmdir -- "$(DESTDIR)$(LIBEXECDIR)"
 	-rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING"
 	-rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE"
@@ -250,6 +306,8 @@ uninstall:
 	-rmdir -- "$(DESTDIR)$(DATADIR)/bash-completion"
 
 
+# Clean rules
+
 .PHONY: all
 clean:
 	-rm -r bin obj src/blueshift_randr.c src/blueshift_vidmode.c