From: Lady <redacted>
Date: Mon, 22 Jan 2024 00:10:20 +0000 (-0500)
Subject: Reformat & update source comments in GNUmakefile
X-Git-Tag: 0.4.3~5
X-Git-Url: https://git.ladys.computer/Shushe/commitdiff_plain/88b64bd7d27884b514b5d8dd3c4412d6378e9fcc?hp=bf451bf2f46fd1ea21f925ee02db620859cf2100

Reformat & update source comments in GNUmakefile

It doesn’t really make sense for make·file comments to be manually
wrapped at 72 characters; none of the actual code can be.
---

diff --git a/GNUmakefile b/GNUmakefile
index f59c4d5..8ce3537 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -81,8 +81,7 @@ endef
 
 # Programs needed to run this make·file.
 #
-# If these are not installed on your computer, or you need to use a
-# different implementation, you can override the appropriate variable.
+# If these are not installed on your computer, or you need to use a different implementation, you can override the appropriate variable.
 AWK := awk
 CAT := cat
 CP := cp
@@ -110,15 +109,13 @@ XSLTPROC := xsltproc
 
 # The directory which contains the source files.
 #
-# Multiple directories can be given so long as files with the same name
-# do not exist in each.
+# Multiple directories can be given so long as files with the same name do not exist in each.
 SRCDIR := sources
 
-# The directory which contains “includes”: Files which may be included
-# in other files but for which no final output will be generated.
+# The directory which contains “includes”:
+# Files which may be included in other files but for which no final output will be generated.
 #
-# Multiple directories can be given so long as files with the same name
-# do not exist in each.
+# Multiple directories can be given so long as files with the same name do not exist in each.
 #
 # These can be inside of `SRCDIR´ directories if desired.
 INCLUDEDIR := sources/includes
@@ -129,38 +126,28 @@ BUILDDIR := build
 # The directory into which to output files on `make install´.
 DESTDIR := public
 
-# The location of this Makefile (and related ⛩️📰 书社 files),
-# relative to the current working directory.
+# The location of this Makefile (and related ⛩️📰 书社 files), relative to the current working directory.
 #
 # By default, this is inferred from the variable `MAKEFILE_LIST´.
 THISDIR := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))
 
 # The location of the magic files to use when determining media types.
 #
-# One is provided as part of this repository, but you can override it
-# if you need different media type detection.
+# One is provided as part of this repository, but you can override it if you need different media type detection.
 #
-# Your computer probably has a more comprehensive one installed at
-# `/usr/share/file/magic´, but it is not recommended that you use this
-# directly. Instead, link or copy just the files you expect to need for
-# your project.
+# Your computer probably has a more comprehensive one installed at `/usr/share/file/magic´, but it is not recommended that you use this directly.
+# Instead, link or copy just the files you expect to need for your project.
 MAGICDIR := $(patsubst ./%,%,$(THISDIR)/magic)
 
 # Configuration of `find´.
 #
-# By default, `find´ will ignore hidden files, those which begin with a
-# period, and those which are likely to cause problems for `make´.
+# By default, `find´ will ignore hidden files, those which begin with a period, and those which are likely to cause problems for `make´.
 FINDRULES := -flags -nohidden -and ! '(' '(' -name '[.-]*' -or -name '*[][*?:|$$%\#;]*' ')' -and -prune ')'
 FINDINCLUDERULES := $(FINDRULES)
 
 # The list of parsers for plaintext file types.
 #
-# Which parsers are provided will influence which kinds of files are
-# recognized as plaintext.
-#
-# Each parser ⁜must⁜ have a template which matches ⁜only⁜ X·H·T·M·L
-# `<script>´ elements that have a `@type´ of a plaintext type supported
-# by the parser. They may have multiple.
+# Which parsers are provided will influence which kinds of files are recognized as plaintext.
 PARSERS := $(patsubst ./%,%,$(wildcard $(THISDIR)/parsers/*.xslt))
 
 # The list of transforms.
@@ -181,12 +168,10 @@ VERBOSE :=
 
 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
 
-# A variable with no value, usable when assigning values which contain
-# whitespace.
+# A variable with no value, usable when assigning values which contain whitespace.
 override empty :=
 
-# A variable which contains a newline, to allow the generation of
-# multiline strings in function calls.
+# A variable which contains a newline, to allow the generation of multiline strings in function calls.
 override define newline
 
 
@@ -204,8 +189,7 @@ override quote = '$(subst ','"'"',$1)'
 # Outputs an `@´ to silence rules, unless `VERBOSE´ is nonempty.
 override silent := $(if $(VERBOSE),,@)
 
-# (callable) Escape special characters for use in sed regular
-# expressions.
+# (callable) Escape special characters for use in sed regular expressions.
 override sedesc = $(subst /,[/],$(subst $$,\$$,$(subst *,\*,$(subst .,\.,$(subst [,\[,$(subst ^,\^,$(subst \,\\,$1)))))))
 
 # (callable) Percent‐decode the given strings.
@@ -213,11 +197,8 @@ override perdec = $(foreach encoded,$1,$(shell $(PRINTF) '%s\n' $(call quote,$(e
 
 # (callable) Percent‐encode the given strings.
 #
-# This singly‐encodes u·r·i characters and doubly‐encodes other
-# characters, then calls `perdec´ to decode back to a single encoding.
-# The encoding assumes the input is a “u·r·i component”; e·g that the
-# resulting string should only contain `pchar´ (but can contain any
-# `sub-delim´).
+# This singly‐encodes u·r·i characters and doubly‐encodes other characters, then calls `perdec´ to decode back to a single encoding.
+# The encoding assumes the input is a “u·r·i component”; e·g that the resulting string should only contain `pchar´ (but can contain any `sub-delim´).
 override perenc = $(foreach unencoded,$1,$(call perdec,$(shell $(PRINTF) '%s' $(call quote,$(unencoded)) | $(OD) -t x1 | $(SED) 's/^[0-9]*//;s/2[146-9A-Ea-e]/%&/g;s/3[0-9AaBbDd]/%&/g;s/40/%&/g;s/[46][1-9A-Fa-f]/%&/g;s/[57][0-9Aa]/%&/g;s/5[Ff]/%&/g;s/7[Ee]/%&/g;s/[ ][0-9A-Fa-f]\{2\}/%25&/g' | $(TR) -d ' \n' | $(TR) 'abcdef' 'ABCDEF')))
 
 # (callable) Percent‐encode each component in the given paths.
@@ -225,24 +206,20 @@ override perenc = $(foreach unencoded,$1,$(call perdec,$(shell $(PRINTF) '%s' $(
 # ☡ This will remove leading and trailing slashes.
 override pathenc = $(foreach path,$1,$(subst $(space),/,$(call perenc,$(subst /, ,$(path)))))
 
-# (overridable) Collect all of the applicable includes from the
-# includes directory.
+# (overridable) Collect all of the applicable includes from the includes directory.
 sourceincludes := $(shell $(FIND) $(foreach dir,$(INCLUDEDIR),$(call quote,$(dir))) -type f '(' $(FINDRULES) ')')
 
-# (overridable) Collect all of the applicable source files from the
-# source directory, removing any which are also includes.
+# (overridable) Collect all of the applicable source files from the source directory, removing any which are also includes.
 sourcefiles := $(filter-out $(sourceincludes),$(shell $(FIND) $(foreach dir,$(SRCDIR),$(call quote,$(dir))) -type f '(' $(FINDRULES) ')'))
 
 ifdef GIT
 ifneq ($(wildcard $(THISDIR)/.git),)
-# (overridable) The name of the current revision of ⛩️📰 书社, or its
-# hash if the current revision is not a tag.
+# (overridable) The name of the current revision of ⛩️📰 书社, or its hash if the current revision is not a tag.
 thisrev = $(shell cd $(THISDIR); $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
 endif
 
 ifneq ($(wildcard .git),)
-# (overridable) The name of the current revision of the working
-# directory, or its hash if the current revision is not a tag.
+# (overridable) The name of the current revision of the working directory, or its hash if the current revision is not a tag.
 srcrev = $(shell $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
 endif
 endif
@@ -257,8 +234,7 @@ ifneq ($(wildcard $(BUILDDIR)/parser.xslt),)
 override plaintexttypes := $(filter-out $(XMLTYPES),$(shell $(XMLLINT) --xpath '/*/*[@name="书社:parsers"]//*[namespace-uri()="http://www.w3.org/1999/xhtml" and local-name()="dd"]/text()' $(call quote,$(BUILDDIR)/parser.xslt)))
 endif
 
-# (callable) Get all of the files (source and includes) which have the
-# given types.
+# (callable) Get all of the files (source and includes) which have the given types.
 override filesoftype = $(foreach type,$1,$(patsubst %|$(type),%,$(filter %|$(type),$(types))))
 
 # Build up collections of various file types.
@@ -290,19 +266,16 @@ override localuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,
 # (callable) Get the source files for the given local uris.
 override sourcefile = $(foreach local,$1,$(patsubst %|$(local),%,$(filter %|$(local),$(sourcelocalpair))))
 
-# Adds a requirement on `$(BUILDDIR)/.update-types´ if the file is
-# present.
+# Adds a requirement on `$(BUILDDIR)/.update-types´ if the file is present.
 #
-# This file is created after a reload due to type changes, and is
-# removed after. Requiring it ensures that file classifications are
-# up‐to‐date immediately after the reload.
+# This file is created after a reload due to type changes, and is removed after.
+# Requiring it ensures that file classifications are up·to·date immediately after the reload.
 override typeupdates := $(wildcard $(BUILDDIR)/.update-types)
 
 # Pair each source file and include with its parsed location.
 override sourceparsedpair := $(foreach file,$(sourcefiles) $(sourceincludes),$(file)|$(BUILDDIR)/$(if $(filter $(file),$(sourceincludes)),includes/$(call includepath,$(file)),sources/$(call sourcepath,$(file))))
 
-# (callable) Get the location of the transformed X·M·L files for the
-# given source files.
+# (callable) Get the location of the transformed X·M·L files for the given source files.
 override parsed = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourceparsedpair))))
 
 # (callable) Get the source files for the given parsed file.
@@ -312,18 +285,15 @@ ifneq ($(wildcard $(BUILDDIR)/dependencies),)
 # Pair each file with a list of dependencies for it.
 override dependenciesforfile := $(foreach file,$(sourcefiles),$(file)|$(subst $(space),|,$(shell $(CAT) $(call quote,$(BUILDDIR)/dependencies) | $(SED) $(call quote,/^$(call sedesc,$(call localuri,$(file)))$$/$(comma)/^[^	]/!d;/^	/!d;s/^	//))))
 
-# (callable) Get the list of dependency leiris for the given source
-# files.
+# (callable) Get the list of dependency leiris for the given source files.
 #
 # Recursive dependencies are marked with a leading `-´.
 override dependencyuris = $(foreach file,$1,$(subst |, ,$(patsubst $(file)|%,%,$(filter $(file)|%,$(dependenciesforfile)))))
 
-# (callable) Get the list of recursive dependencies for the given
-# source files.
+# (callable) Get the list of recursive dependencies for the given source files.
 override recursives = $(foreach uri,$(filter -%,$(call dependencyuris,$1)),$(call sourcefile,$(patsubst -%,%,$(uri))))
 
-# (callable) Get the list of (nonrecursive) dependencies for the given
-# source files.
+# (callable) Get the list of (nonrecursive) dependencies for the given source files.
 override dependencies = $(foreach uri,$(filter-out -%,$(call dependencyuris,$1)),$(call sourcefile,$(uri)))
 endif
 
@@ -348,8 +318,7 @@ override destination = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)
 # Pair each source file with its compiled location.
 override sourcecompiledpair := $(foreach file,$(sourcefiles),$(file)|$(BUILDDIR)/public/$(call destination,$(file)))
 
-# (callable) Get the location of the transformed X·M·L files for the
-# given source files.
+# (callable) Get the location of the transformed X·M·L files for the given source files.
 override compiled = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcecompiledpair))))
 
 # (callable) Get the source files for the given compiled file.
@@ -361,12 +330,10 @@ endif
 
 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
 
-# (callable) Check to see if the given directory exists and
-# create it if not.
+# (callable) Check to see if the given directory exists and create it if not.
 override ensuredirectory = if $(TEST) ! -d $(call quote,$1); then $(MKDIR) -p $(call quote,$1); fi
 
-# (callable) Sanitize and wrap the provided plaintext file in
-#  X·M·L, printing to `stdout´.
+# (callable) Sanitize and wrap the provided plaintext file in X·M·L, printing to `stdout´.
 override wrapplaintext = $(PRINTF) '%s\n' "$$($(PRINTF) '%b' '<?xml version=\042\061.0\042?>\n<script xmlns=\042http://www.w3.org/1999/xhtml\042 type=\042$(call typeoffile,$1)\042><![CDATA['; $(CAT) $(call quote,$1) | $(TR) '\000\013\014' '\032\011\012' | $(SED) $$($(PRINTF) '%s%b' 's/]]>/]]]]><!\[CDATA\[>/g;s/\xEF\xBF\xBE/�/g;s/\xEF\xBF\xBF/�/g;$$!s/\r$$//g;s/\r/\n/g;$$!s/\xC2\x85$$//g;s/\xC2\x85/\n/g;s/\xE2\x80\xA8/\n/g;' 's/[\0001-\0010]/�/g;s/[\0016-\0037]/�/g'); $(PRINTF) '%s' ']]></script>')"
 
 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
@@ -393,15 +360,13 @@ install: $(call installed,$(recursivefiles) $(compilablefiles) $(filter $(source
 list:
 	@$(PRINTF) '%b' $(call quote,$(foreach file,$(sort $(sourcefiles)) $(sort $(sourceincludes)),\0033[1m$(file)\0033[22m|$(call typeoffile,$(file))|[\0033[3m$(if $(filter $(file),$(xmlfiles)),xml,$(if $(filter $(file),$(plaintextfiles)),text,asset))$(if $(filter $(file),$(sourceincludes)),|include,)\0033[23m]$(if $(call dependencies,$(file))$(call recursives,$(file)), $(strip $(foreach recursive,$(call recursives,$(file)),\0033[93;41m•|Recursive|Dependency|\0033[39;49m|$(recursive)) $(foreach dependency,$(call dependencies,$(file)),\0033[2m•|Dependency|\0033[22m|$(dependency))))$(if $(filter $(file),$(sourcefiles)), →|<\0033[4m/$(call destination,$(file))\0033[24m>,) )) | $(TR) ' |' '\n '
 
-# Raise an error when attempting to build any files with recursive
-# dependencies.
+# Raise an error when attempting to build any files with recursive dependencies.
 $(call compiled,$(recursivefiles)):
 	@$(PRINTF) '%b\n' $(call quote,\0033[93;41mError:\0033[39;49m `$(call uncompiled,$@)´ has recursive dependencies:\n$(subst |, ,$(subst $(space),$(newline),$(foreach recursive,$(call recursives,$(call uncompiled,$@)),•|$(recursive))))) && false
 
 # ─ ¶ Special Targets ─────────────────────────────────────────────────
 
-# Perform secondary expansion; this enables pattern rules to determine
-# their prerequisites based on the matched pattern.
+# Perform secondary expansion; this enables pattern rules to determine their prerequisites based on the matched pattern.
 .SECONDEXPANSION: ;
 
 # Don’t use any implicit rules.
@@ -413,12 +378,9 @@ $(call compiled,$(recursivefiles)):
 ifneq ($(wildcard $(BUILDDIR)/.update-types)$(wildcard $(BUILDDIR)/dependencies),)
 # Reload this make·file if the dependency graph has changed.
 #
-# This graph is a dependency for some of the variables that this
-# make·file uses, so it’s important to ensure that they are actually
-# up‐to‐date prior to executing any later rules.
+# The dependency graph and output destinations are used to set the values of variables in this make·file, so it’s important to ensure that they are actually up·to·date prior to executing any later rules.
 #
-# This recipe only exists after types have been updated or when the
-# dependency graph already exists.
+# This recipe only exists after types have been updated or when the dependency graph already exists.
 $(THISDIR)/GNUmakefile:: $(BUILDDIR)/dependencies $(BUILDDIR)/destinations
 	$(silent)$(TOUCH) $(THISDIR)/GNUmakefile
 	$(silent)$(RM) -f $(BUILDDIR)/.update-types
@@ -426,14 +388,11 @@ $(THISDIR)/GNUmakefile:: $(BUILDDIR)/dependencies $(BUILDDIR)/destinations
 endif
 
 ifeq ($(wildcard $(BUILDDIR)/.update-types),)
-# Reload this make·file if any of the magic files or parsers have
-# changed.
+# Reload this make·file if any of the magic files or parsers have changed.
 #
-# These are used to classify source files, so if they have changed then
-# the make·file must be reloaded.
+# These are used to classify source files, so if they have changed then the make·file must be reloaded.
 #
-# This recipe sleeps for one second to ensure that files built after
-# the restart have a more current time·stamp.
+# This recipe sleeps for one second to ensure that files built after the restart have a more current time·stamp.
 $(THISDIR)/GNUmakefile:: $(BUILDDIR)/magic.mgc $(BUILDDIR)/parser.xslt
 	$(silent)$(TOUCH) $(THISDIR)/GNUmakefile
 	$(silent)$(RM) -f $(call quote,$(BUILDDIR)/dependencies)
@@ -447,8 +406,7 @@ endif
 # Generate the compiled magic file from its sources.
 #
 # It must be updated if any of the files in the magic directory change.
-# It ⁜also⁜ should be updated if any of the files in the magic
-# directory are deleted, but this isn’t tracked presently.
+# It ⁜also⁜ should be updated if any of the files in the magic directory are deleted, but this isn’t tracked presently.
 $(BUILDDIR)/magic.mgc: $(wildcard $(MAGICDIR)/*)
 	@$(ECHO) "Compiling new magic…"
 	$(silent)$(call ensuredirectory,$(dir $@))
@@ -465,16 +423,16 @@ $(BUILDDIR)/parser.xslt: $(BUILDDIR)/parser.catalog $(THISDIR)/lib/catalog2parse
 
 # Parse the files.
 #
-# Even plain X·M·L files are parsed, because they may contain X·H·T·M·L
-# `<script>´ elements which contain other kinds of data. Asset files
-# are turned into H·T·M·L embeds pointing to `data:´ U·R·I’s.
+# Even plain X·M·L files are parsed, because they may contain X·H·T·M·L `<script>´ elements which contain other kinds of data.
+# Asset files are turned into H·T·M·L embeds pointing to `data:´ U·R·I’s.
 $(call parsed,$(sourcefiles) $(sourceincludes)): %: $$(call unparsed,$$@) $(typeupdates)
 	@$(PRINTF) '%s\n' $(call quote,Processing `$<´…)
 	$(silent)$(call ensuredirectory,$(dir $@))
 	$(silent)$(if $(filter $<,$(assetfiles)),$(PRINTF) '%s\n' $(call quote,<object xmlns="http://www.w3.org/1999/xhtml" type="$(call typeoffile,$<)" data="$(call datauri,$<)"/>) > $(call quote,$@),$(if $(filter $<,$(plaintextfiles)),$(call wrapplaintext,$<),$(CAT) $(call quote,$<)) | $(XSLTPROC) -o $(call quote,$@) --stringparam BUILDTIME '$(shell TZ= $(DATE) '+%Y-%m-%dT%H:%M:%SZ')' --stringparam SRCTIME '$(shell TZ= $(STAT) -f '%Sm' -t '%Y-%m-%dT%H:%M:%SZ' $(call quote,$(call unparsed,$@)))'$(if $(thisrev), --stringparam VERSION $(call quote,$(thisrev)),)$(if $(srcrev), --stringparam SRCREV $(call quote,$(srcrev)),) $(call quote,$(BUILDDIR)/parser.xslt) -)
 
-# Generate a catalog of all parsed files, for use when processing
-# includes. This does not depend on actually transforming the files.
+# Generate a catalog of all parsed files, for use when processing includes.
+#
+# This does not depend on actually transforming the files.
 $(BUILDDIR)/catalog: $(sourcefiles) $(sourceincludes) $(typeupdates)
 	@$(ECHO) "Generating catalog of parsed files…"
 	$(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
@@ -485,9 +443,10 @@ $(BUILDDIR)/dependencies: $(BUILDDIR)/catalog $(call parsed,$(plaintextfiles) $(
 	@$(ECHO) "Identifying dependencies…"
 	$(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2dependencies.xslt) $(call quote,$<)
 
-# Generate a catalog of destinations for files. This depends on parsing
-# non·asset source files, but not assets or includes. It does not
-# require knowing the dependencies.
+# Generate a catalog of destinations for files.
+#
+# This depends on parsing non·asset source files, but not assets or includes.
+# It does not require knowing the dependencies.
 $(BUILDDIR)/destinations: $(BUILDDIR)/catalog $(call parsed,$(filter-out $(assetfiles),$(sourcefiles))) $(THISDIR)/lib/catalog2destinations.xslt
 	@$(ECHO) "Identifying output destinations…"
 	$(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2destinations.xslt) $(call quote,$<)