X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;ds=sidebyside;f=README;h=e3259c0924414e19770c5fa42007646696ddbdab;hb=033421585dfa781211b558d7acc310b8540ba60e;hp=fd10056368dfdf7d5679b8440c64d2649cb46395;hpb=74b432cc45d829f428a713800ec007dbdf666c37;p=subdirmk.git diff --git a/README b/README index fd10056..e3259c0 100644 --- a/README +++ b/README @@ -90,20 +90,21 @@ 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). +mention its name in Prefix.sd.mk or Suffix.sd.mk (see below). -Perdir.sd.mk, inclusion ------------------------ +Prefix.sd.mk, Suffix.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. +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 @@ -147,7 +148,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) If you `include subdirmk/regen.mk', dependency management and automatic regeneration for all of this template substitution, and for @@ -250,6 +251,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,7 +268,6 @@ So pathname syntax is a subset of: &: .... recognised at start of line only (possibly after lwsp) - args are processed for & &:include filename filename should usually be [&]foo.sd.mk &:-include filename tolerate nonexistent file @@ -292,6 +293,7 @@ So pathname syntax is a subset of: Notably NEWQUOTENEWQUOTE => NEWQUOTENEWQUOTE NEWQUOTE\NEWQUOTE => NEWQUOTE + NEWQUOTE\$ => $ NEWQUOTE:changequote & set escape back to & &TARGETS_things @@ -353,7 +355,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