Commit: runtime(doc): Tweak documentation style

0 views
Skip to first unread message

Christian Brabandt

unread,
Aug 6, 2025, 5:45:17 AM8/6/25
to vim...@googlegroups.com
runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/a7a2a2b5ae45c02416d1489a023a840a7722d444
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Wed Aug 6 11:43:45 2025 +0200

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/17862

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/gui_x11.txt b/runtime/doc/gui_x11.txt
index 4ae03f0e8..318cac836 100644
--- a/runtime/doc/gui_x11.txt
+++ b/runtime/doc/gui_x11.txt
@@ -1,4 +1,4 @@
-*gui_x11.txt* For Vim version 9.1. Last change: 2025 Jul 23
+*gui_x11.txt* For Vim version 9.1. Last change: 2025 Aug 06


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -649,8 +649,7 @@ X11R5 with a library for X11R6 probably doesn't work (although the linking
won't give an error message, Vim will crash later).

*gui-wayland*
-Support for the Wayland display server protocol has landed in patch
-9.1.0064.
+Support for the Wayland display server protocol has landed in patch 9.1.0064.

Note: The Wayland protocol is subject to some restrictions, so the following
functions won't work: |getwinpos()|, |getwinposx()|, |getwinposy()| and the
diff --git a/runtime/doc/os_vms.txt b/runtime/doc/os_vms.txt
index 8951d9e51..6476668e9 100644
--- a/runtime/doc/os_vms.txt
+++ b/runtime/doc/os_vms.txt
@@ -1,4 +1,4 @@
-*os_vms.txt* For Vim version 9.1. Last change: 2025 Jul 22
+*os_vms.txt* For Vim version 9.1. Last change: 2025 Aug 06


VIM REFERENCE MANUAL
@@ -40,7 +40,6 @@ Or using git: >

Older release archives are also available at:
https://ftp.nluug.nl/pub/vim/
- ftp://ftp.nluug.nl/pub/vim/
Or use one of the mirrors:
https://ftp.nluug.nl/pub/vim/MIRRORS

diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt
index ed790ab17..e21cb9d4e 100644
--- a/runtime/doc/quickref.txt
+++ b/runtime/doc/quickref.txt
@@ -1,4 +1,4 @@
-*quickref.txt* For Vim version 9.1. Last change: 2025 Jul 25
+*quickref.txt* For Vim version 9.1. Last change: 2025 Aug 06


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -607,7 +607,7 @@ Short explanation of each option: *option-list*
'arabic' 'arab' for Arabic as a default second language
'arabicshape' 'arshape' do shaping for Arabic characters
'autochdir' 'acd' change directory to the file in the current window
-'autocomplete' 'ac' automatic completion in insert mode
+'autocomplete' 'ac' enable automatic completion in insert mode
'autoindent' 'ai' take indent for new line from previous line
'autoread' 'ar' autom. read file when changed outside of Vim
'autoshelldir' 'asd' change directory to the shell's current directory

Christian Brabandt

unread,
Aug 10, 2025, 3:15:18 AM8/10/25
to vim...@googlegroups.com
runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/57eb1d496bd2337847da9c290b7e1e15177da144
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Sun Aug 10 09:12:46 2025 +0200

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/17959

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/autoload/vimcomplete.vim b/runtime/autoload/vimcomplete.vim
index 81fdf0f7c..7536727a6 100644
--- a/runtime/autoload/vimcomplete.vim
+++ b/runtime/autoload/vimcomplete.vim
@@ -1,14 +1,14 @@
vim9script

# Vim completion script
-# Language: Vimscript
+# Language: Vim script
# Maintainer: Maxim Kim <hab...@gmail.com>
-# Last Change: 2025-07-28
+# Last Change: 2025-08-10
#
# Usage:
# setlocal omnifunc=vimcomplete#Complete
#
-# Simple complete function for the Vimscript
+# Simple complete function for Vim script

var trigger: string = ""
var prefix: string = ""
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
index 8fc3121ab..e31e3573e 100644
--- a/runtime/doc/develop.txt
+++ b/runtime/doc/develop.txt
@@ -1,4 +1,4 @@
-*develop.txt* For Vim version 9.1. Last change: 2025 Aug 08
+*develop.txt* For Vim version 9.1. Last change: 2025 Aug 10


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -308,11 +308,11 @@ Vim's main Makefiles target maximum portability, relying solely on features
defined in POSIX.1-2001 `make` and ignoring later POSIX standards or GNU/BSD
extensions. In practical terms, avoid:

- – % pattern rules
- – modern assignment (`:=`, `::=`) outside POSIX.1-2001
- – special targets (`.ONESHELL`, `.NOTPARALLEL`, `.SILENT`, …)
- – order-only prerequisites (`|`) or automatic directory creation
- – GNU/BSD conditionals (`ifdef`, `ifndef`, `.for`/`.endfor`, …)
+ - % pattern rules
+ - modern assignment (`:=`, `::=`) outside POSIX.1-2001
+ - special targets (`.ONESHELL`, `.NOTPARALLEL`, `.SILENT`, ...)
+ - order-only prerequisites (`|`) or automatic directory creation
+ - GNU/BSD conditionals (`ifdef`, `ifndef`, `.for`/`.endfor`, ...)

Since POSIX.1-2001 supports only traditional suffix rules, every object built
in a separate directory must have an explicit rule. For example:
@@ -339,9 +339,9 @@ Therefore, the latest ISO C standard we follow is:
`C95` (ISO/IEC 9899:1990/AMD1:1995)

In addition, the following `C99` features are explicitly allowed:
- – logical lines may contain up to 4095 characters;
- – `//` comments, as required by |style-comments|;
- – the `_Bool` type.
+ - `//` comments, as required by |style-comments|;
+ - the `_Bool` type.
+ - logical lines may contain up to 4095 characters;

Platform-specific code may use any newer compiler features supported on that
platform.
@@ -349,11 +349,11 @@ platform.

SIZE OF VARIABLES *assumptions-variables*

-We follow POSIX.1‑2001 (SUSv3) for type sizes, which in practice means:
+We follow POSIX.1-2001 (SUSv3) for type sizes, which in practice means:

- char_u 8-bit unsigned
- int ≥ 32-bit signed
- unsigned ≥ 32-bit unsigned
+ char_u 8-bit unsigned
+ int 32-bit or larger signed
+ unsigned 32-bit or larger unsigned


==============================================================================
diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt
index 13007488d..4b2cbc84f 100644
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -1,4 +1,4 @@
-*filetype.txt* For Vim version 9.1. Last change: 2025 Aug 06
+*filetype.txt* For Vim version 9.1. Last change: 2025 Aug 10


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1072,7 +1072,7 @@ The Vim filetype plugin defines the following mappings:
]" move to the next (legacy) comment
[" move to the previous (legacy) comment
gf edit the file under the cursor
- CTRL-W gf edit the file under the cursor in a new tab
+ CTRL-W gf edit the file under the cursor in a new tab page
CTRL-W f edit the file under the cursor in a new window


diff --git a/runtime/ftplugin/vim.vim b/runtime/ftplugin/vim.vim
index fa2135eb4..9b0f89dbe 100644
--- a/runtime/ftplugin/vim.vim
+++ b/runtime/ftplugin/vim.vim
@@ -1,15 +1,14 @@
" Vim filetype plugin
" Language: Vim
" Maintainer: Doug Kearns <dougk...@gmail.com>
-" Last Change: 2025 Aug 07
" Former Maintainer: Bram Moolenaar <Br...@vim.org>
" Contributors: Riley Bruins <rib...@gmail.com> ('commentstring')
" @Konfekt
" @tpope (s:Help())
" @lacygoill
-" Last Change: 2025 Mar 05
+" Last Change: 2025 Aug 07
" 2025 Aug 06 by Vim Project (add gf maps #17881)
-" 2025 Aug 08 by Vim Project (add vimscript complete function #17871)
+" 2025 Aug 08 by Vim Project (add Vim script complete function #17871)

" Only do this when not done yet for this buffer
if exists("b:did_ftplugin")
diff --git a/runtime/pack/dist/opt/helptoc/doc/helptoc.txt b/runtime/pack/dist/opt/helptoc/doc/helptoc.txt
index 3e9760e47..667dadd2b 100644
--- a/runtime/pack/dist/opt/helptoc/doc/helptoc.txt
+++ b/runtime/pack/dist/opt/helptoc/doc/helptoc.txt
@@ -1,4 +1,4 @@
-*helptoc.txt* For Vim version 9.1. Last change: 2025 Aug 06
+*helptoc.txt* For Vim version 9.1. Last change: 2025 Aug 10


VIM REFERENCE MANUAL
@@ -178,7 +178,7 @@ brackets preceding and following each heading's text.

3.7 vim *HelpToc-vim-filetype*

-Vimscript and Vim9 script do not have headings or levels inherently like
+Vim script and Vim9 script do not have headings or levels inherently like
markup languages. However, Vim provides for |folds| defined by markers (|{{{|),
which themselves may be succeeded by a number explicitly indicating the fold
level. This is the structure recognized and supported by helptoc.vim.
Reply all
Reply to author
Forward
0 new messages