]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: explain the impact of stash.index on --autostash options
authorD. Ben Knoble <ben.knoble+github@gmail.com>
Mon, 6 Oct 2025 12:59:29 +0000 (08:59 -0400)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 Oct 2025 00:49:21 +0000 (17:49 -0700)
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>
Documentation/config/stash.adoc

index e556105a15bd46c6489717b0aee663d461f98de1..fcb9a4a7a0faa09f8437829187cc4d79bd9cf07f 100644 (file)
@@ -2,6 +2,10 @@ stash.index::
        If this is set to true, `git stash apply` and `git stash pop` will
        behave as if `--index` was supplied. Defaults to false. See the
        descriptions in linkgit:git-stash[1].
++
+This also affects invocations of linkgit:git-stash[1] via `--autostash` from
+commands like linkgit:git-merge[1], linkgit:git-rebase[1], and
+linkgit:git-pull[1].
 
 stash.showIncludeUntracked::
        If this is set to true, the `git stash show` command will show