docs(make help): Improve documentation

pfitaxel · Aug 20, 2021 · d62a89a · d62a89a
1 parent ee23b9e
commit d62a89a
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/Makefile b/Makefile
@@ -9,21 +9,25 @@ ELC := $(ELFILE:.el=.elc)
 all: elc
 
 help:
-	@echo '$$ make elc    # byte-compile $(ELFILE)'
+	@echo '$$ make elc  # byte-compile $(ELFILE)'
 	@echo '$$ make bump v=1.0.0  # Replace version strings with 1.0.0'
 	@echo ''
-	@echo 'All the following commands require sudo.'
+	@echo 'All the make commands below involve "sudo docker".'
 	@echo ''
-	@echo '$$ make back   # Run a docker backend for interactive ERT tests'
+	@echo '$$ make back  # Run a docker backend for interactive ERT tests'
+	@echo '$$ make back USE_PASSWD=true  # Same, with mail/passwd enabled'
 	@echo '$$ make back LEARNOCAML_IMAGE=ocamlsf/learn-ocaml LEARNOCAML_VERSION=0.12'
+	@echo '$$ cat teacher.txt  # initial Teacher token'
+	@echo '$$ cat confirm.txt  # mail confirmation URLs (this needs USE_PASSWD=true)'
 	@echo ''
 	@echo '$$ make emacs  # Run a dockerized emacs for ERT tests'
 	@echo '$$ make tests  # Run dockerized ERT tests'
+	@echo '$$ make tests USE_PASSWD=true'
 	@echo ''
-	@echo '$$ make dist-tests    # Alias-of: make back emacs tests'
+	@echo '$$ make dist-tests  # Alias-of: make back emacs tests'
 	@echo '$$ make dist-tests USE_PASSWD=true'
 	@echo ''
-	@echo '$$ make stop   # Stop the docker backend and/or ERT frontend'
+	@echo '$$ make stop  # Stop the docker backend and/or ERT frontend'
 
 bump:
 	git diff -p --raw --exit-code || { echo >&2 "*** Please commit beforehand ***"; exit 1; }