From 0f83f37ffc28e5b611ebd3b30d748fd5a0758d20 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 26 Feb 2026 20:09:35 -0500 Subject: [PATCH] GNUmakefile.mjo: improve some comments that act as documentation --- GNUmakefile.mjo | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/GNUmakefile.mjo b/GNUmakefile.mjo index 54e2d44..72fbb03 100644 --- a/GNUmakefile.mjo +++ b/GNUmakefile.mjo @@ -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) -- 2.51.0