[Xen-changelog] [xen stable-4.7] oxenstored: comments explaining some variables

[patchbot@xxxxxxx]

commit fb79c3a3e89aae106f6645e51b55ee76d8999631
Author:     Thomas Sanders <thomas.sanders@xxxxxxxxxx>
AuthorDate: Tue Mar 14 12:15:52 2017 +0000
Commit:     Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>
CommitDate: Wed Apr 5 15:14:43 2017 +0100

    oxenstored: comments explaining some variables
    
    It took a while of reading and reasoning to work out what these are
    for, so here are comments to make life easier for everyone reading
    this code in future.
    
    Reported-by: Juergen Gross <jgross@xxxxxxxx>
    Signed-off-by: Thomas Sanders <thomas.sanders@xxxxxxxxxx>
    Reviewed-by: Jonathan Davies <jonathan.davies@xxxxxxxxxx>
    Reviewed-by: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
    Reviewed-by: Christian Lindig <christian.lindig@xxxxxxxxxx>
---
 tools/ocaml/xenstored/store.ml       |  1 +
 tools/ocaml/xenstored/transaction.ml | 10 +++++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/tools/ocaml/xenstored/store.ml b/tools/ocaml/xenstored/store.ml
index 223ee21..9f619b8 100644
--- a/tools/ocaml/xenstored/store.ml
+++ b/tools/ocaml/xenstored/store.ml
@@ -211,6 +211,7 @@ let apply rnode path fct =
        lookup rnode path fct
 end
 
+(* The Store.t type *)
 type t =
 {
        mutable stat_transaction_coalesce: int;
diff --git a/tools/ocaml/xenstored/transaction.ml 
b/tools/ocaml/xenstored/transaction.ml
index 6b37fc2..51d5d6a 100644
--- a/tools/ocaml/xenstored/transaction.ml
+++ b/tools/ocaml/xenstored/transaction.ml
@@ -69,11 +69,15 @@ let can_coalesce oldroot currentroot path =
        else
                false
 
-type ty = No | Full of (int * Store.Node.t * Store.t)
+type ty = No | Full of (
+       int *          (* Transaction id *)
+       Store.Node.t * (* Original root *)
+       Store.t        (* A pointer to the canonical store: its root changes on 
each transaction-commit *)
+)
 
 type t = {
        ty: ty;
-       store: Store.t;
+       store: Store.t; (* This is the store that we change in write 
operations. *)
        quota: Quota.t;
        mutable paths: (Xenbus.Xb.Op.operation * Store.Path.t) list;
        mutable operations: (Packet.request * Packet.response) list;
@@ -155,7 +159,7 @@ let commit ~con t =
        let has_commited =
        match t.ty with
        | No                         -> true
-       | Full (id, oldroot, cstore) ->
+       | Full (id, oldroot, cstore) ->       (* "cstore" meaning current 
canonical store *)
                let commit_partial oldroot cstore store =
                        (* get the lowest path of the query and verify that it 
hasn't
                           been modified by others transactions. *)
--
generated by git-patchbot for /home/xen/git/xen.git#stable-4.7

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog