about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBart Schaefer <schaefer@zsh.org>2024-01-24 18:06:44 -0800
committerBart Schaefer <schaefer@zsh.org>2024-01-24 18:06:44 -0800
commit2a538491ebdaaf41ad07e5b7a4d4d994faafb355 (patch)
tree16c3e86656b44adbc7ff2c7949d1d192b5adbadd
parent1f861ceba1d5740798caa0a3f208f3047c6e3ff5 (diff)
downloadzsh-2a538491ebdaaf41ad07e5b7a4d4d994faafb355.tar.gz
zsh-2a538491ebdaaf41ad07e5b7a4d4d994faafb355.tar.xz
zsh-2a538491ebdaaf41ad07e5b7a4d4d994faafb355.zip
52496 + 52377: clarify SPROMPT behavior when CORRECT_ALL is set
-rw-r--r--ChangeLog3
-rw-r--r--Doc/Zsh/options.yo8
-rw-r--r--Doc/Zsh/params.yo10
3 files changed, 17 insertions, 4 deletions
diff --git a/ChangeLog b/ChangeLog
index b876cb6d1..ecb883c75 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2024-01-24  Bart Schaefer  <schaefer@zsh.org>
 
+	* 52496 + 52377: Doc/Zsh/options.yo, Doc/Zsh/params.yo: clarify
+	SPROMPT behavior when CORRECT_ALL is set
+
 	* 52492: Src/math.c: prevent indexing error when using recursive
 	arithmetic in array subscript (operator stops on operand error)
 
diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index cbd3d0f8e..c3af8dd33 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -1214,6 +1214,9 @@ Note that, when the tt(HASH_LIST_ALL) option is not set or when some
 directories in the path are not readable, this may falsely report spelling
 errors the first time some commands are used.
 
+Refer to the shell variable tt(SPROMPT) for an explanation of the
+`tt([nyae])' (no/yes/abort/edit) prompt that is offered.
+
 The shell variable tt(CORRECT_IGNORE) may be set to a pattern to
 match words that will never be offered as corrections.
 )
@@ -1222,7 +1225,10 @@ pindex(NO_CORRECT_ALL)
 pindex(CORRECTALL)
 pindex(NOCORRECTALL)
 item(tt(CORRECT_ALL) (tt(-O)))(
-Try to correct the spelling of all arguments in a line.
+Try to correct the spelling of all arguments in a line, in order from
+left to right, treating each as a file name.  Answering `tt(a)' or
+`tt(e)' at any prompt stops all corrections, otherwise every correction
+is prompted for.
 
 The shell variable tt(CORRECT_IGNORE_FILE) may be set to a pattern to
 match file names that will never be offered as corrections.
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index 68df4a16f..a6fbe6723 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -1635,9 +1635,13 @@ All other prompt escapes are also allowed.
 
 The actions available at the prompt are tt([nyae]):
 startsitem()
-sitem(tt(n) +LPAR()`no'+RPAR() +LPAR()default+RPAR())(Discard the correction and run the command.)
-sitem(tt(y) +LPAR()`yes'+RPAR())(Make the correction and run the command.)
-sitem(tt(a) +LPAR()`abort'+RPAR())(Discard the entire command line without running it.)
+sitem(tt(n) +LPAR()`no'+RPAR() +LPAR()default+RPAR())(Discard the correction.
+If there are no more corrections, accept the command line, else (with
+tt(CORRECT_ALL)) prompt for the next.)
+sitem(tt(y) +LPAR()`yes'+RPAR())(Make the correction. If there are no more
+corrections, accept the command line.)
+sitem(tt(a) +LPAR()`abort'+RPAR())(Place the entire command line in the
+history for later edit, but without accepting it.)
 sitem(tt(e) +LPAR()`edit'+RPAR())(Resume editing the command line.)
 endsitem()
 )