Comment polishing.

[open-adventure.git] / Makefile

diff --git a/Makefile b/Makefile
index 38139dec2f89210d7860dc927ddfa022a7d25eff..0f82c4a69833ba42ac8390073410e795e07937fd 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
 # Makefile for the open-source release of adventure 2.5
 
 # To build with save/resume disabled, pass CFLAGS="-DADVENT_NOSAVE"
-# To build with auto-save/resume enabled, pass CFLAGS="-D ADVENT_AUTOSAVE"
+# To build with auto-save/resume enabled, pass CFLAGS="-DADVENT_AUTOSAVE"
 
 VERS=$(shell sed -n <NEWS '/^[0-9]/s/:.*//p' | head -1)
 
@@ -65,10 +65,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
@@ -129,6 +131,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