docs: Summarise directory reference syntaxes, permute

[subdirmk.git] / README

diff --git a/README b/README
index 1111dcb90fb7ce57ed7acd70bbe0bbbb8f275baa..5a585df4f26d3a1f042622712aec99232994edc0 100644 (file)
--- a/README
+++ b/README
@@ -138,6 +138,19 @@ If you `include subdirmk/regen.mk', dependency management and
 automatic regeneration for all of this template substitution, and for
 config.status etc. is done for you.
 
+Summary of directory reference syntaxes
+---------------------------------------
+
+                  In build tree             In source tree             
+                  Relative  Absolute        Relative     Absolute      
+                                          
+                  &file     $(abs)/&file                             
+ This directory   &/file    $(abs)/&/file   &^/file      &~/file       
+                  & f g h                   & ^ f g h    & ~ f g h     
+                                          
+ Top level        file      $(abs)/file     $(ts)/file   $(ats)/file   
+                  f g h                                              
+
 Substitution syntax
 -------------------