From: Sage Weil <sage@redhat.com>
Date: Fri, 7 Sep 2018 16:01:24 +0000 (-0500)
Subject: doc/dev/msgr2: clarify padding alignment
X-Git-Tag: v14.0.1~355^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b24e187b5ac90bad21f050c141cf42ee97ccb20c;p=ceph.git

doc/dev/msgr2: clarify padding alignment

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/doc/dev/msgr2.rst b/doc/dev/msgr2.rst
index 9cf13123b43b..67777737def7 100644
--- a/doc/dev/msgr2.rst
+++ b/doc/dev/msgr2.rst
@@ -177,8 +177,8 @@ authentication method as the first attempt:
                 |        auth done|
 
 
-Message frame format
---------------------
+Post-auth frame format
+----------------------
 
 The frame format is fixed (see above), but can take three different
 forms, depending on the AUTH_DONE flags:
@@ -190,6 +190,11 @@ forms, depending on the AUTH_DONE flags:
     payload
     payload_padding (out to auth block_size)
 
+  - The padding is some number of bytes < the auth block_size that
+    brings the total length of the payload + payload_padding to a
+    multiple of block_size.  It does not include the frame_len or tag.  Padding
+    content can be zeros or (better) random bytes.
+
 * If FLAG_SIGNED has been specified::
 
     frame_len