]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/dev: clarify meaning of `late_flags` in msgr2
authorJohannes Cornelis Draaijer <jcdra1@gmail.com>
Fri, 26 Dec 2025 22:02:28 +0000 (23:02 +0100)
committerJohannes Cornelis Draaijer <jcdra1@gmail.com>
Sat, 27 Dec 2025 10:33:44 +0000 (11:33 +0100)
Signed-off-by: Johannes Cornelis Draaijer <jcdra1@gmail.com>
doc/dev/msgr2.rst

index e8542d3d7bbf0ebc9d44378818f09f328a7cf12e..6f799aecce548a441fc7c44ccc8ed264ed0b5ad5 100644 (file)
@@ -206,10 +206,13 @@ Differences from msgr2.0-crc:
    empty).  Rationale: If the frame has only one segment, it cannot
    be aborted and there are no crcs to store in the epilogue.
 
-3. Unchecksummed late_flags is replaced with late_status which
-   builds in bit error detection by using a 4-bit nibble per flag
+3. Unchecksummed ``late_flags`` is replaced with ``late_status``.
+   A completed frame is indicated by a ``late_flags`` value of
+   ``FRAME_LATE_STATUS_COMPLETE``, while an aborted frame is indicated
+   by a value of ``FRAME_LATE_STATUS_ABORTED``. This adjusted field
+   has better bit error detection by using a 4-bit nibble per flag
    and two code words that are Hamming Distance = 4 apart (and not
-   all zeros or ones).  This comes at the expense of having only
+   all zeros or ones). This comes at the expense of having only
    one reserved flag, of course.
 
 Some example frames: