Warnings: Introduce new `broken-var-ref' warning

[secnet.git] / README

diff --git a/README b/README
index efd96be277c4c417a04eb4df31d9bd9ca741cee2..e303788b362856eb0474c4b2618c49b35ee32288 100644 (file)
--- a/README
+++ b/README
@@ -336,6 +336,11 @@ suppressed with the &:warn directive.  The warning tags are:
        by more letters.  Note that &$FOO works differently to
        raw make: it expands to $(sub_dir_FOO).
 
+    broken-var-ref
+        An attempt at variable expansion looking like $&...
+       You probably expected this to mean $(TOP_F)BAR but it
+       expands to $TOP_FBAR which make thinks means $(T)OP_FBAR.
+
     unknown-warning
        &:warn was used to try to enable a warning that this version
        of subdirmk does not understand.  (Note that an attempt to
@@ -361,8 +366,9 @@ In your configure.ac, say
   m4_include([subdirmk/subdirmk.ac])
   SUBDIRMK_SUBDIRS([...list of subdirectories in relative syntax...])
 
-Write a Dir.sd.mk in each directory.  The toplevel one should
-probably contain:
+Write a Dir.sd.mk in each directory.  See the substitution syntax
+reference, above, and the example/ directory here.  The toplevel
+Dir.sd.mk should probably contain:
 
   include subdirmk/usual.mk
   include subdirmk/regen.mk