From cd5dd131d5fc0ad5ff554cfd6c62c3b3689211e2 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Thu, 18 Nov 2021 22:54:35 +0530
Subject: [PATCH] Explain shortening of key names during serialization

---
 docs/file-transfer-protocol.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/file-transfer-protocol.rst b/docs/file-transfer-protocol.rst
index 12c42b3e9..8a6afc988 100644
--- a/docs/file-transfer-protocol.rst
+++ b/docs/file-transfer-protocol.rst
@@ -258,7 +258,11 @@ the numeralization of the word ``file``.
     data              d        base64_bytes   Binary data
     ================= ======== ============== =======================================================================
 
-Here:
+The ``Key name`` is the actual serialized name fo the key sent in the escape
+code. So for example, ``permissions=123`` is serialized as ``prm=123``. This
+is done to reduce overhead.
+
+The value types are:
 
 enum
     One from a permitted set of values, for example::