diff options
| author | Victoria Dye <vdye@github.com> | 2022-03-15 01:49:38 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-03-14 18:51:56 -0700 |
| commit | e86ec71d20d14861e4a3d047800d3ea3099c946d (patch) | |
| tree | 1be721f5bc59d44756050af50202c042e41aaaad /Documentation | |
| parent | 1a4874565fa3b6668042216189551b98b4dc0b1b (diff) | |
| download | git-e86ec71d20d14861e4a3d047800d3ea3099c946d.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config/advice.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index c40eb09cb7..971aad2f23 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -69,8 +69,8 @@ advice.*:: merge to avoid overwriting local changes. resetQuiet:: Advice to consider using the `--quiet` option to linkgit:git-reset[1] - when the command takes more than 2 seconds to enumerate unstaged - changes after reset. + when the command takes more than 2 seconds to refresh the index + after reset. resolveConflict:: Advice shown by various commands when conflicts prevent the operation from being performed. |