From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Thu, 14 Nov 2019 12:59:30 +0000 (+0000)
Subject: docs: New plan for directory references
X-Git-Tag: subdirmk/0.1~21
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=subdirmk.git;a=commitdiff_plain;h=10b511fc2feaaf18a62eeb57087c2527ff71ce11

docs: New plan for directory references

Not yet implemented.  About to simplify this...

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/README b/README
index 5a585df..5bfb29e 100644
--- a/README
+++ b/README
@@ -141,15 +141,17 @@ config.status etc. is done for you.
 Summary of directory reference syntaxes
 ---------------------------------------
 
-                  In build tree             In source tree             
-                  Relative  Absolute        Relative     Absolute      
+      Recommended     In build tree             In source tree
+             when     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                                              
+  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
+             .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
 -------------------
@@ -182,6 +184,11 @@ empty string).
 &^		=>	$(top_srcdir)/sub/dir		or $(top_srcdir)
 &~		=>	$(abs_top_srcdir)/sub/dir	or $(abs_top_srcdir)
 
+In general:
+        ^       filenames in source tree rather than build tree
+        ~       filenames are absolute rather than relative
+        @       filenames do not contain subdir (useful with the above)
+
 &&		=>	&&		for convenience in shell runes
 \&		=>	&		general escaping mechanism