strategy.tex

   1 When we are trying to do a merge of some kind, in general,
   2 we want to merge some source commits $S_0 \ldots S_n$.
   3 We'll write $S_0 = L$.  We require that $L$ is the current git ref
   4 for $\patchof{L}$.
   5
   6 \stdsection{Notation}
   7
   8 \begin{basedescript}{
   9 \desclabelwidth{5em}
  10 \desclabelstyle{\nextlinelabel}
  11 }
  12 \item[ $\depsreqof{K}$ ]
  13 The set of direct dependencies (in the form $\py$)
  14 requested in the commit $K$ ($K \in \pn$) for the patch $\p$.
  15
  16 \item[ $\pc \hasdirdep \p$ ]
  17 The Topbloke commit set $\pc$ has as a direct contributors the
  18 commit set $\p$.  This is an acyclic relation.
  19
  20 \item[ $\p \hasdep \pq$ ]
  21 The commit set $\p$ has as direct or indirect contributor the commit
  22 set $\pq$.
  23 Acyclic; the completion of $\hasdirdep$ into a
  24 partial order.
  25
  26 \item[ $\set E_{\pc}$ ]
  27 $ \bigcup_i \pendsof{S_i}{\pc} $.
  28 All the ends of $\pc$ in the sources.
  29
  30 \item[ $ \grefzc, \grefcc, \grefuc, \greffc $ ]
  31 The git ref for the Topbloke commit set $\pc$: respectively,
  32 the original, current, updated, and final values.
  33
  34 \end{basedescript}
  35
  36 \section{Planning phase}
  37
  38 The planning phase computes:
  39 \begin{itemize*}
  40 \item{ The relation $\hasdirdep$ and hence the ordering $\hasdep$. }
  41 \item{ For each commit set $\pc$, the order in which to merge
  42         $E_{\pc,j} \in \set E_{\pc}$. }
  43 \item{ For each $E_{\pc,j}$ an intended merge base $M_{\pc,j}$. }
  44 \end{itemize*}
  45
  46 We use a recursive planning algorith, recursing over Topbloke commit
  47 sets (ie, sets $\py$ or $\pn$).  We'll call the commit set we're
  48 processing at each step $\pc$.
  49 At each recursive step
  50 we make a plan to merge all $\set E_{\pc} = \{ E_{\pc,j \ldots} \}$
  51 and all the direct contributors of $\pc$ (as determined below)
  52 into $\grefzc$, to make $\greffc$.
  53
  54 We start with $\pc = \pl$ where $\pl = \patchof{L}$.
  55
  56
  57 \subsection{Direct contributors for $\pc = \pcn$}
  58
  59 The direct contributors of $\pcn$ are the commit sets corresponding to
  60 the tip branches for the direct dependencies of the patch $\pc$.  We
  61 need to calculate what the direct dependencies are going to be.
  62
  63 Choose an (arbitrary, but ideally somehow optimal in
  64 a way not discussed here) ordering of $\set E_{\pc}$, $E_{\pc,j}$
  65 ($j = 1 \ldots m$).
  66 For brevity we will write $E_j$ for $E_{\pc,j}$.
  67 Remove from that set (and ordering) any $E_j$ which
  68 are $\le$ and $\neq$ some other $E_k$.
  69
  70 Initially let $\set D_0 = \depsreqof{\grefzc}$.
  71 For each $E_j$ starting with $j=1$ choose a corresponding intended
  72 merge base $M_j$ such that $M_j \le E_j \land M_j \le T_{\pc,j-1}$.
  73 Calculate $\set D_j$ as the 3-way merge of the sets $\set D_{j-1}$ and
  74 $\depsreqof{E_j}$ using as a base $\depsreqof{M_j}$.  This will
  75 generate $D_m$ as the putative direct contributors of $\pcn$.
  76
  77 However, the invocation may give instructions that certain direct
  78 dependencies are definitely to be included, or excluded.  As a result
  79 the set of actual direct contributors is some arbitrary set of patches
  80 (strictly, some arbitrary set of Topbloke tip commit sets).
  81
  82 \subsection{Direct contributors for $\pc = \pcy$}
  83
  84 The sole direct contributor of $\pcy$ is $\pcn$.
  85
  86 \subsection{Recursive step}
  87
  88 For each direct contributor $\p$, we add the edge $\pc \hasdirdep \p$
  89 and augment the ordering $\hasdep$ accordingly.
  90
  91 If this would make a cycle in $\hasdep$, we abort . The operation must
  92 then be retried by the user, if desired, but with different or
  93 additional instructions for modifying the direct contributors of some
  94 $\pqn$ involved in the cycle.
  95
  96 For each such $\p$, after updating $\hasdep$, we recursively make a plan
  97 for $\pc' = \p$.
  98
  99 \section{Execution phase}
 100
 101 We process commit sets from the bottom up according to the relation
 102 $\hasdep$.  For each commit set $\pc$ we construct $\greffc$ from
 103 $\grefzc$, as planned.  By construction, $\hasdep$ has $\patchof{L}$
 104 as its maximum, so this operation will finish by updating
 105 $\greffa{\patchof{L}}$.
 106
 107 After we are done, the result has the following properties:
 108 \[ \eqn{Tip Inputs}{
 109   \bigforall_{E_i \in \set E_{\pc}} \greffc \ge E_i
 110 }\]
 111 \[ \eqn{Tip Dependencies}{
 112   \bigforall_{\pc \hasdep \p} \greffc \ge \greffa \p
 113 }\]
 114 \[ \eqn{Perfect Contents}{
 115   \greffc \haspatch \p \equiv \pc \hasdep \py
 116 }\]
 117
 118 For brevity we will write $\grefu$ for $\grefuc$, etc.  We will start
 119 out with $\grefc = \grefz$, and at each step of the way construct some
 120 $\grefu$ from $\grefc$.  The final $\grefu$ becomes $\greff$.
 121
 122 \subsection{Preparation}
 123
 124 Firstly, we will check each $E_i$ for being $\ge \grefc$.  If
 125 it is, are we fast forward to $E_i$
 126 --- formally, $\grefu = \text{max}(\grefc, E_i)$ ---
 127 and drop $E_i$ from the planned ordering.
 128
 129 \subsection{Merge Contributors for $\pcy$}
 130
 131 Merge $\pcn$ into $\grefc$.  That is, merge with
 132 $L = \grefc, R = \greffa{\pcn}, M = \baseof{\grefc}$.
 133 to construct $\grefu$.
 134
 135 Merge conditions: Ingredients satisfied by construction.
 136 Tip Merge satisfied by construction.  Merge Acyclic follows
 137 from Perfect Contents and $\hasdep$ being acyclic.
 138
 139 Removal Merge Ends: For $\p = \pc$, $M \nothaspatch \p$.
 140 For $p \neq \pc$, by Tip Contents,
 141 $M \haspatch \p \equiv L \haspatch \p$, so we need only
 142 worry about $X = R, Y = L$; ie $L \haspatch \p$,
 143 $M = \baseof{L} \haspatch \p$.
 144 By Tip Contents for $L$, $D \le L \equiv D \le M$.  $\qed$
 145
 146 WIP UP TO HERE
 147
 148 Addition Merge Ends: If $\py \isdep \pcn$, we have already
 149 done the execution phase for $\pcn$ and $\py$.  By
 150 Perfect Contents for $\pcn$, $\greffa \pcn \haspatch \p$.
 151
 152 computed $\greffa \py$, and by Perfect Contents for $\py$
 153
 154
 155 with $M=M_j, L=T_{\pc,j-1}, R=E_j$,
 156 and calculate what the resulting desired direct dependencies file
 157 (ie, the set of patches $\set D_j$)
 158 would be.  Eventually we
 159
 160 So, formally, we select somehow an order of sources $S_i$.  For each
 161
 162
 163 Make use of the following recursive algorithm, Plan
 164
 165
 166
 167
 168  recursively make a plan to merge all $E = \pends$
 169
 170 Specifically, in