wip new props arrangements; before abolish props

[topbloke.git] / FORMAT

diff --git a/FORMAT b/FORMAT
index e411d3875fa978e7908561a3f02ff23bce2ccd4b..1b823f05a1c9f8fe95e9ca412d666163f0e09969 100644 (file)
--- a/FORMAT
+++ b/FORMAT
@@ -10,31 +10,37 @@ In-tree, there are metadata files in .topbloke
     Files which are per-patch and do not inherit any contents
     or changes from bases or dependencies:
 
-       msg             brach "commit message"
+       msg             patch "commit message"
                        ("# not applicable" in bases)
 
        deps            direct dependencies, one per line
                        as either:
-                               topbloke patch name
-                               /refs/heads/<something>
-                       ("# not applicable" in bases)
-
-       flags           flags that apply to this patch, one per line
-                       base has its own, perhaps different, set of flags;
-                        Unknown flags starting with [a-z] are ok;
-                        otherwise fatal.  Currently defined flags:
-                               Deleted         patch is deleted
-                                               (valid on tip only)
+                               <topbloke patch name>
+                               .f <ref name including refs/heads/>
+                               .tg <ref name not including refs/heads/>
+                       (empty in base branches)
+
+       props           properties that apply to this patch, one per line
+                        in the format "<name>[ <value>]" (exactly one
+                        space) where value can contain spaces and
+                        a missing value is distinct from a missing property
+                        but value if present must be nonempty
+                       base has its own, perhaps different, set of props;
+                        Unknown props starting with [a-z] are ok;
+                        otherwise fatal.  Currently defined props:
+               patch <name>    topbloke patch name (in tip and base)
+               topgit <name>   this is a topgit import (in tip and base)
+               Deleted         patch is deleted (in tip only, no value)
 
     Files which not inherit contents and changes from dependencies:
 
        included        actual included deps, one per line
                                format as for deps
 
-       pflags          flags that apply to this patch and all its
-                       dependencies (ie, flags that propagate)
-                        Unknown flags starting with [a-z] are ok;
-                        otherwise fatal.  No currently defined flags
+       pprops          properties that apply to this patch and all its
+                       dependencies (ie, properties that propagate)
+                        Unknown props starting with [a-z] are ok;
+                        otherwise fatal.  No currently defined props.
 
 
 <full-name> has the format: