X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=Makefile;h=003935d6fd9f207d2c935d4dbf8d1fa3c92bff64;hb=1ce4fc2ac3d3bd09996ea342311ad141e56f343d;hp=4e5f3316f814f9b2b106cc75054016af3a0477d6;hpb=3f34adad3b6596b3a99175b071f83e70a5e0d594;p=open-adventure.git

diff --git a/Makefile b/Makefile
index 4e5f331..003935d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,10 @@
 # Makefile for the open-source release of adventure 2.5
 
+# SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
+
 # To build with save/resume disabled, pass CFLAGS="-DADVENT_NOSAVE"
+# To build with auto-save/resume enabled, pass CFLAGS="-DADVENT_AUTOSAVE"
 
 VERS=$(shell sed -n <NEWS '/^[0-9]/s/:.*//p' | head -1)
 
@@ -64,10 +68,12 @@ cheat: $(CHEAT_OBJS) dungeon.o
 check: advent cheat
 	cd tests; $(MAKE) --quiet
 
+# Requires gcov, lcov, libasan6, and libubsan1
+# The last two are Ubuntu names, might vary onb other distributions.
 # After this, run your browser on coverage/open-adventure/index.html
 # to see coverage results. Browse coverage/adventure.yaml.html
 # to see symbol coverage over the YAML file.
-coverage: debug
+coverage: clean debug
 	cd tests; $(MAKE) coverage --quiet
 
 .SUFFIXES: .adoc .html .6
@@ -128,6 +134,11 @@ linty: CCFLAGS += -Winit-self
 linty: CCFLAGS += -Wpointer-arith
 linty: advent cheat
 
+# These seem to be more modeern options for enabling coverage testing.
+# Documenting them here in case a future version bump disables --coverage.
+#debug: CCFLAGS += -ftest-coverage
+#debug: CCFLAGS += -fprofile-arcs
+
 debug: CCFLAGS += -O0
 debug: CCFLAGS += --coverage
 debug: CCFLAGS += -ggdb