]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): clarify term_cols allowed range in terminal.txt
authorKalin KOZHUHAROV <me.kalin@gmail.com>
Fri, 6 Feb 2026 14:55:12 +0000 (14:55 +0000)
committerChristian Brabandt <cb@256bit.org>
Fri, 6 Feb 2026 14:55:12 +0000 (14:55 +0000)
Patch 9.0.1527 (related issue: vim/vim#12362) introduced range checking
for `term_cols` parameter of the various terminal related functions, but
did not update the documentation. This is the fix, hopefully I found
everything that mentions is. Also improve the style for `term_rows` to
match.

Code reference ( https://github.com/vim/vim/blob/master/src/job.c#L456 ):
if (opt->jo_term_cols < 0 || opt->jo_term_cols > 1000)

closes: #19346

Signed-off-by: Kalin Kozhuharov <kalin@thinrope.net>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/terminal.txt

index 083f013cc17daf310673fb086a05298d6c942c07..c4f227d090c74a75f49bc100705ac0468b22412c 100644 (file)
@@ -1,4 +1,4 @@
-*terminal.txt* For Vim version 9.1.  Last change: 2026 Jan 18
+*terminal.txt* For Vim version 9.1.  Last change: 2026 Feb 06
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -525,10 +525,12 @@ term_dumpdiff({filename}, {filename} [, {options}])
                                     of the first file name.
                   "term_rows"       vertical size to use for the terminal,
                                     instead of using 'termwinsize', but
-                                    respecting the minimal size
+                                    respecting the minimal size; valid range
+                                    is from 0 to 1000
                   "term_cols"       horizontal size to use for the terminal,
                                     instead of using 'termwinsize', but
-                                    respecting the minimal size
+                                    respecting the minimal size; valid range
+                                    is from 0 to 1000
                   "vertical"        split the window vertically
                   "curwin"          use the current window, do not split the
                                     window; fails if the current buffer
@@ -951,9 +953,10 @@ term_start({cmd} [, {options}])                    *term_start()*
                                     of the command name.
                   "term_rows"       vertical size to use for the terminal,
                                     instead of using 'termwinsize'; valid
-                                    range is from zero to 1000
+                                    range is from 0 to 1000
                   "term_cols"       horizontal size to use for the terminal,
-                                    instead of using 'termwinsize'
+                                    instead of using 'termwinsize'; valid
+                                    range is from 0 to 1000
                   "vertical"        split the window vertically; note that
                                     other window position can be defined with
                                     command modifiers, such as |:belowright|.