X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?p=subdirmk.git;a=blobdiff_plain;f=README;h=7de4def345f95bdfa39f6da34992be894b22e11f;hp=6bc8e82d8611f4a31525e9c0f22590446d170a1a;hb=963054a07f6670d984c3e69280bde4832ca837d6;hpb=f99c7def1e8afb27b0df6c605ff6847f676d6bfe

diff --git a/README b/README
index 6bc8e82..7de4def 100644
--- a/README
+++ b/README
@@ -83,33 +83,38 @@ targets may be in run in parallel: there is only one `make' invocation
 at a time.  There is no sequencing between subdirectories, only been
 individual targets (as specified according to their dependencies).
 
-You can define other per-directory recursive targets too: simply
-mention (usually, by setting) the variable &TARGETS_zonk, or whatever.
-This will create a src/zonk target (for appropriate value of src/).
-Unlike `all', these other targets only exist in areas of the project
-where at least something mentions them.  So for example, if
-&TARGETS_zonk is mentioned in src but not lib, `make zonk' in
-lib will fail.  If you want to make a target exist everywhere,
-mention its name in Perdir.sd.mk (see below).
-
-Perdir.sd.mk, inclusion
------------------------
-
-The file Perdir.sd.mk in the toplevel of the source is automatically
-processed after each individual directory's Subdir.sd.mk, and the
-&-substituted contents therefore appear once for each subdirectory.
+You can define other per-directory recursive targets too: set the
+variable &TARGETS_zonk, or whatever (being sure to write &TARGETS_zonk
+at the start of a line).  This will create a src/zonk target (for
+appropriate value of src/).  Unlike `all', these other targets only
+exist in areas of the project where at least something mentions them.
+So for example, if &TARGETS_zonk is set in src but not lib, `make
+zonk' in lib will fail.  If you want to make a target exist
+everywhere, += it with nothing in Prefix.sd.mk or Suffix.sd.mk (see
+below).
+
+Prefix.sd.mk, Suffix.sd.mk, Final.sd.mk, inclusion
+--------------------------------------------------
+
+The files Prefix.sd.mk and Suffix.sd.mk in the toplevel of the source
+are automatically processed before and after each individual
+directory's Subdir.sd.mk, and the &-substituted contents therefore
+appear once for each subdirectory.
 
 This lets you do per-directory boilerplate.  Some useful boilerplate
 is already provided in subdirmk, for you to reference like this:
   &:include subdirmk/cdeps.sd.mk
   &:include subdirmk/clean.sd.mk
-For example you could put that in Perdir.sd.mk.
+For example you could put that in Suffix.sd.mk.
 
 The top-level Subdir.sd.mk is the first makefile included after the
 autogenerated `main.mk' which merely has some basic settings and
 includes.  So if you want to get in early and set global variables,
 put them near the top of Subdir.sd.mk.
 
+The file Final.sd.mk in the toplevel directory is processed and
+included after all the other files.
+
 subdirmk's filter script itself sets (only) these variables:
   top_srcdir
   abs_top_srcdir
@@ -147,7 +152,7 @@ There are two kinds of template files.
  How to include           `&:include foo.sd.mk'   `include foo.mk'
 			  in all relevant .sd.mk  in only one
                           (but not needed for     Subdir.sd.mk
-                           Subdir and Perdir)
+                           Prefix, Suffix, Final)
 
 If you `include subdirmk/regen.mk', dependency management and
 automatic regeneration for all of this template substitution, and for
@@ -250,6 +255,7 @@ So pathname syntax is a subset of:
 
 &\&		=>	&		general escaping mechanism
 &\$		=>	$
+&\NEWLINE				eats the newline and vanishes
 
 &$VARIABLE	=>	$(sub_dir_VARIABLE)	or $(TOP_VARIABLE)
 	VARIABLE is ASCII starting with a letter and matching \w+
@@ -266,11 +272,11 @@ So pathname syntax is a subset of:
 
 &:<directive> <args>....
 	recognised at start of line only (possibly after lwsp)
-	args are processed for &
 
-&:include filename		filename should usually be foo.sd.mk
+&:include filename		filename should usually be [&]foo.sd.mk
 &:-include filename		tolerate nonexistent file
 	filenames are relative to $(top_srcdir)
+	RHS is &-expanded
 
 &!<lwsp>	disables & until EOL (and then disappears)
 
@@ -291,10 +297,12 @@ So pathname syntax is a subset of:
 	Notably
 		NEWQUOTENEWQUOTE	=> NEWQUOTENEWQUOTE
 		NEWQUOTE\NEWQUOTE	=> NEWQUOTE
+		NEWQUOTE\$		=> $
 		NEWQUOTE:changequote &	set escape back to &
 
 &TARGETS_things
-	Handled specially.  If mentioned, declares that this
+	Handled specially.  If mentioned at the start of a line
+	(possibly following whitespace), declares that this
 	subdir ought to have a target `things'.  The rule will be
 		&/things:: $(&TARGETS_things)
 
@@ -308,9 +316,9 @@ So pathname syntax is a subset of:
 	which recursively implies this directory's `things'.
 
 	Must be spelled exactly &TARGETS_things.  &_TARGETS_things,
-	for example, is not magic.  But mentioning &TARGETS_things in
-	a #-comment *does* work because the & filter does not care
-	about comments.
+	for example, is not magic.  To make the target exist
+	without providing any prerequisites for it, write a line
+	containing just `&TARGETS_things +='.
 
 	`all' is extra special: every directory has an `all'
 	target, which corresponds to &TARGETS.
@@ -351,7 +359,7 @@ probably contain:
   include subdirmk/usual.mk
   include subdirmk/regen.mk
 
-Write a Perdir.sd.mk in the toplevel, if you want.  It should probably
+Write a Suffix.sd.mk in the toplevel, if you want.  It should probably
 have:
 
   &:include subdirmk/cdeps.sd.mk