From fb73f78c91633115396ee8a701b46bbdee2654ca Mon Sep 17 00:00:00 2001
From: Christopher Haster <geky@geky.net>
Date: Wed, 31 Jul 2024 12:29:13 -0500
Subject: [PATCH] Updated comments to prefer "canonical checksum" for rbyd
 checksums

I think this describes the goal of the non-perturbed rbyd checksums
decently. At the very least it's less wrong that "data checksum", and
calling it the "metadata checksum" would just be confusing. (Would our
commit checksum be the "metametadata checksum" then?)
---
 lfs.c               | 8 ++++----
 scripts/dbgbmap.py  | 2 +-
 scripts/dbgbtree.py | 2 +-
 scripts/dbglfs.py   | 2 +-
 scripts/dbgmtree.py | 2 +-
 scripts/dbgrbyd.py  | 4 ++--
 6 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/lfs.c b/lfs.c
index 31752b7c..37a90d01 100644
--- a/lfs.c
+++ b/lfs.c
@@ -2284,7 +2284,7 @@ static int lfsr_rbyd_fetch(lfs_t *lfs, lfsr_rbyd_t *rbyd,
                 rbyd->weight = weight;
                 ecksum = ecksum_;
 
-                // revert to data checksum
+                // revert to canonical checksum
                 cksum_ = cksum;
                 ecksum_.cksize = -1;
             }
@@ -2311,7 +2311,7 @@ static int lfsr_rbyd_fetch(lfs_t *lfs, lfsr_rbyd_t *rbyd,
 
             // end of trunk?
             if (!lfsr_tag_isalt(tag)) {
-                // update data checksum
+                // update canonical checksum
                 cksum = cksum_;
                 // update trunk and weight, unless we are a shrub trunk
                 if (!lfsr_tag_isshrub(tag) || trunk__ == trunk) {
@@ -3371,7 +3371,7 @@ static int lfsr_rbyd_appendcksum(lfs_t *lfs, lfsr_rbyd_t *rbyd) {
         return err;
     }
 
-    // save the data checksum
+    // save the canonical checksum
     uint32_t cksum = rbyd->cksum;
 
     // align to the next prog unit
@@ -3501,7 +3501,7 @@ static int lfsr_rbyd_appendcksum(lfs_t *lfs, lfsr_rbyd_t *rbyd) {
             = ((lfs_size_t)perturb
                 << (8*sizeof(lfs_size_t)-1))
             | off_;
-    // revert to data checksum
+    // revert to canonical checksum
     rbyd->cksum = cksum;
     return 0;
 }
diff --git a/scripts/dbgbmap.py b/scripts/dbgbmap.py
index dbff6281..f3fb584d 100755
--- a/scripts/dbgbmap.py
+++ b/scripts/dbgbmap.py
@@ -713,7 +713,7 @@ class Rbyd:
 
                 # end of trunk?
                 if not tag & TAG_ALT:
-                    # update data checksum
+                    # update canonical checksum
                     cksum_ = cksum__
                     # update trunk/weight unless we found a shrub or an
                     # explicit trunk (which may be a shrub) is requested
diff --git a/scripts/dbgbtree.py b/scripts/dbgbtree.py
index 5b8f1415..ded2b8b0 100755
--- a/scripts/dbgbtree.py
+++ b/scripts/dbgbtree.py
@@ -386,7 +386,7 @@ class Rbyd:
 
                 # end of trunk?
                 if not tag & TAG_ALT:
-                    # update data checksum
+                    # update canonical checksum
                     cksum_ = cksum__
                     # update trunk/weight unless we found a shrub or an
                     # explicit trunk (which may be a shrub) is requested
diff --git a/scripts/dbglfs.py b/scripts/dbglfs.py
index 403059d2..9a26c0b8 100755
--- a/scripts/dbglfs.py
+++ b/scripts/dbglfs.py
@@ -417,7 +417,7 @@ class Rbyd:
 
                 # end of trunk?
                 if not tag & TAG_ALT:
-                    # update data checksum
+                    # update canonical checksum
                     cksum_ = cksum__
                     # update trunk/weight unless we found a shrub or an
                     # explicit trunk (which may be a shrub) is requested
diff --git a/scripts/dbgmtree.py b/scripts/dbgmtree.py
index 34647262..05d533a9 100755
--- a/scripts/dbgmtree.py
+++ b/scripts/dbgmtree.py
@@ -401,7 +401,7 @@ class Rbyd:
 
                 # end of trunk?
                 if not tag & TAG_ALT:
-                    # update data checksum
+                    # update canonical checksum
                     cksum_ = cksum__
                     # update trunk/weight unless we found a shrub or an
                     # explicit trunk (which may be a shrub) is requested
diff --git a/scripts/dbgrbyd.py b/scripts/dbgrbyd.py
index 24404d2f..cd6d1463 100755
--- a/scripts/dbgrbyd.py
+++ b/scripts/dbgrbyd.py
@@ -580,7 +580,7 @@ def dbg_log(data, block_size, rev, eoff, weight, *,
                 upper_ += w
 
             if not tag & TAG_ALT:
-                # update data checksum
+                # update canonical checksum
                 cksum = cksum_
                 # derive the current tag's rid from alt weights
                 rid = lower_ + w-1
@@ -997,7 +997,7 @@ def main(disk, blocks=None, *,
 
                 # end of trunk?
                 if not tag & TAG_ALT:
-                    # update data checksum
+                    # update canonical checksum
                     cksum_ = cksum__
                     # update trunk/weight unless we found a shrub or an
                     # explicit trunk (which may be a shrub) is requested