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

[subdirmk.git] / README

diff --git a/README b/README
index a44fb492b47301ea3bbbef8c102c645c5e4c9f8c..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