[PATCH v3 3/4] glossary: add reachability bitmap description

From: Philip Oakley <philipoakley@iee.email>
To: GitList <git@vger.kernel.org>
Cc: Self <philipoakley@iee.email>, Junio C Hamano <gitster@pobox.com>,
	Derrick Stolee <stolee@gmail.com>,
	Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>,
	Taylor Blau <ttaylorr@github.com>
Subject: [PATCH v3 3/4] glossary: add reachability bitmap description
Date: Sat, 29 Oct 2022 17:41:11 +0100	[thread overview]
Message-ID: <20221029164112.2097-4-philipoakley@iee.email> (raw)
In-Reply-To: <20221029164112.2097-1-philipoakley@iee.email>

Describe the purpose of the reachability bitmap.

Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
 Documentation/glossary-content.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index a526710278..5a537268e2 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -508,6 +508,14 @@ exclude;;
 	<<def_tree_object,trees>> to the trees or <<def_blob_object,blobs>>
 	that they contain.
 
+[[def_reachability_bitmap]]reachability bitmaps::
+	Reachability bitmaps store information about the
+	<<def_reachable,reachability>> of a selected set of commits in
+	a packfile, or a multi-pack index (MIDX), to speed up object search.
+	The bitmaps are stored in a ".bitmap" file. A repository may have at
+	most one bitmap file in use. The bitmap file may belong to either one
+	pack, or the repository's multi-pack index (if it exists).
+
 [[def_rebase]]rebase::
 	To reapply a series of changes from a <<def_branch,branch>> to a
 	different base, and reset the <<def_head,head>> of that branch
-- 
2.38.1.windows.1

