chiark / gitweb /
wip thoughts about props reorg
[topbloke.git] / FORMAT
diff --git a/FORMAT b/FORMAT
index 258e073205cb39874e446435c7eceb06fd19902e..473946e32f37daec824e4176f2fd924d6a4c029f 100644 (file)
--- a/FORMAT
+++ b/FORMAT
@@ -1,4 +1,4 @@
-Topbloke branch is:
+Topbloke patch is:
        - branch in refs/topbloke-tips/<full-name>
                contains the working version, fast-forwarding
        - branch in refs/topbloke-bases/<full-name>
@@ -7,20 +7,47 @@ Topbloke branch is:
 
 In-tree, there are metadata files in .topbloke
 
-       msg             brach "commit message"
+    Files which are per-patch and do not inherit any contents
+    or changes from bases or dependencies:
+
+       msg             patch "commit message"
+                       ("# not applicable" in bases)
 
        deps            direct dependencies, one per line
                        as either:
-                               topbloke branch name
-                               /refs/heads/<something>
+                               <topbloke patch name>
+                               .f <ref name including refs/heads/>
+                               .tg <ref name not including refs/heads/>
+                       (empty in base branches)
+
+       deleted         exists (but empty) if branch is deleted
+                       exist in tip only branch
+
+       patch-          name of this topbloke patch (plus a newline)
+                       exists in base and tip
+
+       topgit-         name of the topgit branch that this was
+                       imported from and which we should merge from
+                       (plus a newline); exists in tip only
+
+       [^+]*-          another property that applies to this patch;
+                       if not known to this version of topbloke then it
+                       is safe to:
+                         - merge this file as text when merging
+                           from base into base or tip into tip
+                         - throw away this file when merging from
+                           base into tip or from dep into base
+
+    Files which inherit contents and changes from dependencies
+    have names starting with "+":
 
-       included        actual included branches, one per line
-                               topbloke branch name
+       +included       actual included deps, one per line
+                               format as for deps
 
-       flags           flags that apply to this branch, one per line
-                        unknown flags starting with [a-z] are ok;
-                        otherwise fatal.  Currently defined flags:
-                               Deleted         branch is deleted
+       +*-             another property that is inherited; it is also
+                       safe to:
+                        - merge this file as text when merging
+                          from tb deps into bases or bases into tips
 
 
 <full-name> has the format:
@@ -31,18 +58,18 @@ eg
        ijackson@chiark.greenend.org.uk/2012-01-20T225127Z/reorg/sponge
 NB only exactly that date format is allowed and timezone must be Z.
 
-Branches may be specified as
-       [<qualifier>/...]<nickname-path-spec>
+Patches may be specified as
+       [<qualifier>/...][<nickname-path-spec>]
 where <qualifier>/ is one of
        [<email>]@[<domain.name>/
-               Only branches matching the specified email local part
+               Only patches matching the specified email local part
                or domain name match
        [<date-spec>/]
                A prefix of the ISO8601 date spec, stopping
                just after a numeric component (or at the end)
        [<approx-date-containing-~>/]
                Intepreted by date -d after ~s have been replaced by
-               spaces.  When we come to select, take the branch
+               spaces.  When we come to select, take the patch
                nearest that date rather than the most recent
 
 
@@ -53,11 +80,11 @@ where <qualifier>/ is one of
 
 <date-spec> may be
        <approximate date spec containing at least one ~>
-               means all branches are candidates
+               means all patches are candidates
 
-So overall, if the current branch is
+So overall, if the current patch is
        ijackson@chiark.greenend.org.uk/2011-08-20T120320Z/fixes/pudding
-then all of the following can refer to the same branch
+then all of the following can refer to the same patch
        ./sponge
        ../reorg/sponge
        reorg/sponge
@@ -71,9 +98,9 @@ then all of the following can refer to the same branch
        ijackson@chiark.greenend.org.uk/2012-01-20T225127Z/reorg/sponge
 
 Search algorithm:
-       1. prefer branches with email address (or domain)
-          matching current branch
-       2. prefer branches with our own email address (or domain)
-       3. other branches
-Within this there may be branches with multiple dates; prefer the most
+       1. prefer patches with email address (or domain)
+          matching current patch
+       2. prefer patches with our own email address (or domain)
+       3. other patches
+Within this there may be patches with multiple dates; prefer the most
 recent.