git: document GIT_NO_REPLACE_OBJECTS environment variable
commitb3806f7633f69d44a2ade95b92ba21fb59362f4e
authorJunio C Hamano <gitster@pobox.com>
Fri, 16 Feb 2024 17:22:20 +0000 (16 09:22 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 27 Feb 2024 06:08:49 +0000 (26 22:08 -0800)
treee7566be8a72f2619d4fb0a856e4b74ff78a811ef
parentc784b0a5b991cc8ee179b8f3a8fc0b762708947d
git: document GIT_NO_REPLACE_OBJECTS environment variable

This variable is used as the primary way to disable the object
replacement mechanism, with the "--no-replace-objects" command line
option as an end-user visible way to set it, but has not been
documented.

The original reason why it was left undocumented might be because it
was meant as an internal implementation detail, but the thing is,
that our tests use the environment variable directly without the
command line option, and there certainly are folks who learned its
use from there, making it impossible to deprecate or change its
behaviour by now.

Add documentation and note that for this variable, unlike many
boolean-looking environment variables, only the presence matters,
not what value it is set to.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git.txt