[PATCH v2 1/2] Documentation/gitformat-pack.txt: fix typo
- From
Taylor Blau <me@ttaylorr.com>
- Date
- Oct 31, 2023, 19:24 UTC
- Message-ID
- <92e9bee4ad39906c773e4a6eba84ec1ebf8c1d3b.1698780244.git.me@ttaylorr.com>
- In-Reply-To
- <cover.1698780244.git.me@ttaylorr.com>
e0d1bcf825 (multi-pack-index: add format details, 2018-07-12) describes the MIDX's "PNAM" chunk as having entries which are "null-terminated strings".
This is a typo, as strings are terminated with a NUL character, which is a distinct concept from "NULL" or "null", which we typically reserve for the void pointer to address 0.
Correct the documentation accordingly.
Signed-off-by: Taylor Blau <me@ttaylorr.com> --- Documentation/gitformat-pack.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index 4a4d87e7db..c4eb09d52a 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt @@ -390,7 +390,7 @@ CHUNK LOOKUP: CHUNK DATA: Packfile Names (ID: {'P', 'N', 'A', 'M'}) - Stores the packfile names as concatenated, null-terminated strings. + Stores the packfile names as concatenated, NUL-terminated strings. Packfiles must be listed in lexicographic order for fast lookups by name. This is the only chunk not guaranteed to be a multiple of four bytes in length, so should be the last chunk for alignment reasons.
-- 2.42.0.527.ge89c67d052