]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation/gitformat-pack.txt: fix typo
authorTaylor Blau <me@ttaylorr.com>
Tue, 31 Oct 2023 19:24:08 +0000 (15:24 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 1 Nov 2023 04:25:02 +0000 (13:25 +0900)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitformat-pack.txt

index 0c1be2dbe85caf3300a314c374dd12d54b7434a7..4b7e6da1e785f197f35e8e50ed0a21b94dd20be1 100644 (file)
@@ -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.