doc: explain the impact of stash.index on --autostash options
With 9842c0c749 (stash: honor stash.index in apply, pop modes, 2025-09-21) merged in a5d4779e6e (Merge branch 'dk/stash-apply-index', 2025-09-29), we did not advertise the connection between the new config option stash.index and the implicit use of git-stash via --autostash (which may also be configured). Do so. Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
D. Ben Knoble committed
Oct 6, 2025 at 08:59 UTC
55269ece0473833af19958672f58d7b85cfb4b7c
1 file changed
+4
Documentation/config/stash.adoc
+4
@@ -2,6 +2,10 @@ stash.index::
2
If this is set to true, `git stash apply` and `git stash pop` will
3
behave as if `--index` was supplied. Defaults to false. See the
4
descriptions in linkgit:git-stash[1].
5
++
6
+This also affects invocations of linkgit:git-stash[1] via `--autostash` from
7
+commands like linkgit:git-merge[1], linkgit:git-rebase[1], and
8
+linkgit:git-pull[1].
9
10
stash.showIncludeUntracked::
11
If this is set to true, the `git stash show` command will show