read_istream_pack_non_delta(): document input handling
commit0afbe3e806f48a701188eefd8d7c474cc119df53
authorJeff King <peff@peff.net>
Wed, 31 Oct 2018 05:13:16 +0000 (31 01:13 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 31 Oct 2018 05:32:30 +0000 (31 14:32 +0900)
tree805aba5d2281a281a946f3e899759b6e932b3563
parentcae598d9980661a978e2df4fb338518f7bf09572
read_istream_pack_non_delta(): document input handling

Twice now we have scratched our heads about why the loose streaming code
needs the protection added by 692f0bc7ae (avoid infinite loop in
read_istream_loose, 2013-03-25), but the similar code in its pack
counterpart does not.

The short answer is that use_pack() will die before it lets us run out
of bytes. Note that this could mean reading garbage (including the
trailing hash) from the packfile in some cases of corruption, but that's
OK. zlib will notice and complain (and if not, certainly the end result
will not match the object hash we expect).

Let's leave a comment this time to document our findings.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
streaming.c