reset: revise index refresh advice

vdye · gitster · commit e86ec71d20d1 · 2022-03-14T18:51:56.000-07:00
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 &lt;vdye@github.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git 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.
diff --git a/builtin/reset.c b/builtin/reset.c
@@ -525,9 +525,9 @@ int cmd_reset(int argc, const char **argv, const char *prefix)
 					      _("Unstaged changes after reset:"));
 				t_delta_in_ms = (getnanotime() - t_begin) / 1000000;
 				if (advice_enabled(ADVICE_RESET_QUIET_WARNING) && t_delta_in_ms > REFRESH_INDEX_DELAY_WARNING_IN_MS) {
-					printf(_("\nIt took %.2f seconds to enumerate unstaged changes after reset.  You can\n"
+					advise(_("It took %.2f seconds to refresh the index after reset.  You can\n"
 						"use '--quiet' to avoid this.  Set the config setting reset.quiet to true\n"
-						"to make this the default.\n"), t_delta_in_ms / 1000.0);
+						"to make this the default."), t_delta_in_ms / 1000.0);
 				}
 			}
 		} else {

Original file line number	Diff line number	Diff line change
`@@ -525,9 +525,9 @@ int cmd_reset(int argc, const char *argv, const char prefix)`
`525`	`525`	`_("Unstaged changes after reset:"));`
`526`	`526`	`t_delta_in_ms = (getnanotime() - t_begin) / 1000000;`
`527`	`527`	`if (advice_enabled(ADVICE_RESET_QUIET_WARNING) && t_delta_in_ms > REFRESH_INDEX_DELAY_WARNING_IN_MS) {`
`528`		`- printf(_("\nIt took %.2f seconds to enumerate unstaged changes after reset. You can\n"`
	`528`	`+ advise(_("It took %.2f seconds to refresh the index after reset. You can\n"`
`529`	`529`	`"use '--quiet' to avoid this. Set the config setting reset.quiet to true\n"`
`530`		`- "to make this the default.\n"), t_delta_in_ms / 1000.0);`
	`530`	`+ "to make this the default."), t_delta_in_ms / 1000.0);`
`531`	`531`	`}`
`532`	`532`	`}`
`533`	`533`	`} else {`