]> gitweb.michael.orlitzky.com - mjotex.git/commitdiff
GNUmakefile.mjo: improve some comments that act as documentation
authorMichael Orlitzky <michael@orlitzky.com>
Fri, 27 Feb 2026 01:09:35 +0000 (20:09 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Fri, 27 Feb 2026 01:09:35 +0000 (20:09 -0500)
GNUmakefile.mjo

index 54e2d4461c32b68cd2b61218102800bd0220d3f7..72fbb03ad0a3c72a5fe1a7c8c837405b1bc0fad0 100644 (file)
@@ -1,25 +1,28 @@
-# The name of this document.
+# The name of the document; that is, the name of the main tex file,
+# but without the .tex suffix.
 #
-# For example, to use the name of our parent directory, after
+# The default will use the name of the parent directory after
 # stripping the ".git" suffix (if there is one).
 #
-# PN = examples
+# PN = your-document-name
 PN ?= $(patsubst %.git,%,$(notdir $(realpath .)))
 
-# A space-separated list of bib files. These must all belong to paths
-# contained in your $BIBINPUTS environment variable.
+# A space-separated list of bib files. Automatically added to
+# $(SRCS). These must all belong to paths contained in your $BIBINPUTS
+# environment variable.
 #
 # Leave commented if you don't use a bibliography database.
 #
 # BIBS = local-references.bib
 
-# A space-separated list of the mjotex files that you use. The path to
-# mjotex must be contain in your $TEXINPUTS environment variable.
+# A space-separated list of the mjotex files that you
+# use. Automatically added to $(SRCS). The path to mjotex must be
+# contain in your $TEXINPUTS environment variable.
 #
 # MJOTEX  = mjotex.sty
 
-# Compile a list of raw source code listings (*.listing) and their
-# associated output files (*.sage.py) that will be tested by check-sage.
+# A space separated list of sage code listings. Automatically added to
+# $(SRCS). The "check-sage" target can doctest these for you.
 #
 # SAGE_LISTINGS = $(wildcard sage-listings/*.listing)