Make on Codrut Constantin Gusoi

Test for Emacs compiler warnings

Sat, 10 Sep 2022 10:55:37 +0000

Setup Link to heading

Your .gitignore:

*.elc

A Makefile containing:

.PHONY: compile
compile:
	@emacs -q -batch \
	  --eval '(setq byte-compile-error-on-warn t)' \
	  -f batch-byte-compile \
	  *.el

The first indentation is a tab, the following two are spaces. Makefiles just work this way for reasons beyond human comprehension.

Run Link to heading

Executing make compile will compile all your .el files and error in case there are any warnings.

Basic Makefile CI steps

Sat, 14 Nov 2020 11:59:51 +0000

Create general ci and lint goals for running things with and without docker, and specific ci/* and lint/* goals for individual checks:

#-------------------------------------------------------------------------------
# CI
#-------------------------------------------------------------------------------

# Absolute path to the directory of this Makefile.
HERE = $(realpath $(dir $(realpath $(firstword $(MAKEFILE_LIST)))))

# Run a docker container with the current directory mounted.
DOCKER_HERE := docker run --rm -it -u `id -u`:`id -g` -v "$(PWD)":/here -w /here

.PHONY: ci
ci: ci/editorconfig ci/hadolint ci/yamllint

.PHONY: ci/editorconfig
ci/editorconfig:
	@$(DOCKER_HERE) sdwolfz/editorconfig-checker:latest make lint/editorconfig

.PHONY: ci/hadolint
ci/hadolint:
	@$(DOCKER_HERE) sdwolfz/hadolint:latest make lint/hadolint

.PHONY: ci/yamllint
ci/yamllint:
	@$(DOCKER_HERE) sdwolfz/yamllint:latest make lint/yamllint

#-------------------------------------------------------------------------------
# Lint

.PHONY: lint
lint: lint/editorconfig lint/hadolint lint/yamllint

.PHONY: lint/editorconfig
lint/editorconfig:
	@editorconfig-checker $$(git ls-files)

.PHONY: lint/hadolint
lint/hadolint:
	@hadolint $$(git ls-files | grep Dockerfile)

.PHONY: lint/yamllint
lint/yamllint:
	@yamllint $$(git ls-files | grep -E \.ya?ml$$)

Basic Makefile starter

Fri, 17 Jul 2020 18:14:29 +0000

Use this template as a sterter for your Makefile, making sure you intent using tabs as that’s a hard requirement of the make tool.

#-------------------------------------------------------------------------------
# Settings
#-------------------------------------------------------------------------------

# By default the `help` goal is executed.
.DEFAULT_GOAL := help

#-------------------------------------------------------------------------------
# Goals
#-------------------------------------------------------------------------------

.PHONY: help
help:
	@echo 'Usage: make [<GOAL_1>, ...] [<VARIABLE_1>=value_1, ...]'
	@echo ''
	@echo 'Examples:'
	@echo '  make'
	@echo '  make help'
	@echo ''
	@echo 'Goals:'
	@echo '  - help: Displays this help message.'
	@echo '  - here: Displays the directory where this Makefile is located.'
	@echo ''
	@echo 'Default Goal: help'
	@echo ''