docs: New plan for directory references, further

[secnet.git] / README

diff --git a/README b/README
index 5bfb29ebdecf5cfdd00246e8319427a04464c4b9..3059d9a105cfb57a9071a4da0f50e9cc19783a62 100644 (file)
--- a/README
+++ b/README
@@ -138,20 +138,32 @@ 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
----------------------------------------
+Summary of recommended directory reference syntaxes
+---------------------------------------------------
+
+Path construction &-expansions, meanings summary:
+
+                      In build tree            In source tree
+  This directory      just &                   &,
+  Top level           &.  implies absolute     &;
+
+Adding `@' means "absolute path".  This is not needed with &. because
+there is never any need to use &. since it would expand to nothing.
+`/' terminates the escape (needed if the next thing is not a lowercase
+character, or space).  `=' means "just the value, no /".  Space starts
+multi-word processing.
 
       Recommended     In build tree             In source tree
              when     Relative  Absolute        Relative     Absolute
                                           
-  This       lc       &file     &~file          &^file       &^~file
-  directory  any      &/file    &~/file         &^/file      &^~/file
-             several  & f g h   & ~ f g h       & ^ f g h    & ^~ f g h
+  This       lc       &file     &@file          &,file       &@,file
+  directory  any      &/file    &@/file         &,/file      &@,/file
+             several  & f g h   &@ f g h        &, f g h     &@, f g h
 
-  Top        lc                 &@~file         &@^file      &@~^file
-  level      any      file      &@~/file        &@^/file     &@~^/file
+  Top        lc                 &.file          &;file       &@;file
+  level      any      file      &./file         &;/file      &@;/file
+             several  f g h     &. f g h        &; f g h     &@; f g h
              .mk.in   file      $(abs)/file     $(src)/file  $(abs_src)/file
-             several  f g h     & @~ f g h      & @^ f g h   & @~^ f g h
 
 Substitution syntax
 -------------------