[PATCH 5/6] reftable: clarify how empty tables should be written

From: Han-Wen Nienhuys via GitGitGadget <gitgitgadget@gmail.com>
Date: May 20, 2020, 17:36 UTC
Message-ID: <c645298ef024ac30617e66fa7ab879875aca1d2f.1589996173.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.638.git.1589996173.gitgitgadget@gmail.com>

From: Han-Wen Nienhuys <hanwen@google.com>

The format allows for some ambiguity, as a lone footer also starts with a valid file header. However, the current JGit code will barf on this. This commit codifies this behavior into the standard.

Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/technical/reftable.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/technical/reftable.txt b/Documentation/technical/reftable.txt
index c5ed127b188..e53823c9bfb 100644
--- a/Documentation/technical/reftable.txt
+++ b/Documentation/technical/reftable.txt
@@ -733,6 +733,12 @@ version)
 
 Once verified, the other fields of the footer can be accessed.
 
+Empty tables
+++++++++++++
+
+A reftable may be empty. In this case, the file starts with a header
+and is immediately followed by a footer.
+
 Binary search
 ^^^^^^^^^^^^^

-- 
gitgitgadget