wip

[topbloke.git] / FORMAT

diff --git a/FORMAT b/FORMAT
index 258e073205cb39874e446435c7eceb06fd19902e..447a3fbd939792f63ca549d9aac6173c7ef42332 100644 (file)
--- a/FORMAT
+++ b/FORMAT
@@ -7,6 +7,9 @@ Topbloke branch is:
 
 In-tree, there are metadata files in .topbloke
 
+    Files which are per-branch and do not inherit any contents
+    or changes from dependencies:
+
        msg             brach "commit message"
 
        deps            direct dependencies, one per line
@@ -14,15 +17,23 @@ In-tree, there are metadata files in .topbloke
                                topbloke branch name
                                /refs/heads/<something>
 
-       included        actual included branches, one per line
-                               topbloke branch name
-
        flags           flags that apply to this branch, one per line
-                        unknown flags starting with [a-z] are ok;
+                        Unknown flags starting with [a-z] are ok;
                         otherwise fatal.  Currently defined flags:
                                Deleted         branch is deleted
 
 
+    Files which not inherit contents and changes from dependencies:
+
+       included        actual included branches, one per line
+                               topbloke branch name
+
+       pflags          flags that apply to this branch and all its
+                       dependencies (ie, flags that propagate)
+                        Unknown flags starting with [a-z] are ok;
+                        otherwise fatal.  No currently defined flags
+
+
 <full-name> has the format:
        <email>@<domain.name>/<yyyy>-<mm>-<dd>T<hh><mm><ss>Z/<nickname-path>
 where nickname-path's first component must not start with a digit