Re: [PATCH v2 1/2] Documentation: describe connectivity checking

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 5, 2026, 19:17 UTC
Message-ID: <xmqqece4j6t4.fsf@gitster.g>
In-Reply-To: <asNY7SfEohsOSf0J@pks.im>

Patrick Steinhardt <ps@pks.im> writes:

Show 9 quoted lines

>> +Full connectivity check
>> +-----------------------
>> +
>> +`check_connected()` (see `connected.c`) normally performs the
>
> I'm always a bit hesitant to directly refer to code in our docs. We
> should either make this documentation part of "connected.c" directly, or
> we should not refer to code. Otherwise, chances that this documentation
> grows stale is very high.

This is totally outside the topic of documentation updates, but it makes me wonder if we should pay attention to connectivity roots other than refs (like index entries) that we use when we run fsck.