]> git.ipfire.org Git - thirdparty/git.git/commit
reset: revise index refresh advice
authorVictoria Dye <vdye@github.com>
Tue, 15 Mar 2022 01:49:38 +0000 (01:49 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 15 Mar 2022 01:51:56 +0000 (18:51 -0700)
commite86ec71d20d14861e4a3d047800d3ea3099c946d
tree1be721f5bc59d44756050af50202c042e41aaaad
parent1a4874565fa3b6668042216189551b98b4dc0b1b
reset: revise index refresh advice

Update the advice describing index refresh from "enumerate unstaged changes"
to "refresh the index." Describing 'refresh_index(...)' as "enumerating
unstaged changes" is not fully representative of what an index refresh is
doing; more generally, it updates the properties of index entries that are
affected by outside-of-index state, e.g. CE_UPTODATE, which is affected by
the file contents on-disk. This distinction is relevant to operations that
read the index but do not refresh first - e.g., 'git read-tree' - where a
stale index may cause incorrect behavior.

In addition to changing the advice message, use the "advise" function to
print advice.

Signed-off-by: Victoria Dye <vdye@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/advice.txt
builtin/reset.c