From 2494009885b6d8073017ee3c7e16bcc1796c4c99 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Sun, 12 Nov 2023 07:49:57 +0800 Subject: [PATCH] vim-patch:1b08d2cd0789 (#25993) runtime(doc): clarify when formatoptions applies closes: vim/vim#13503 https://github.com/vim/vim/commit/1b08d2cd0789fd9aaae148a64ff46342730022d7 Co-authored-by: Christian Brabandt --- runtime/doc/options.txt | 5 +++-- runtime/lua/vim/_meta/options.lua | 5 +++-- src/nvim/options.lua | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index d92e528214..6a71ad296c 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2774,8 +2774,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'formatoptions' 'fo' string (default "tcqj") local to buffer This is a sequence of letters which describes how automatic - formatting is to be done. See |fo-table|. Commas can be inserted for - readability. + formatting is to be done. + See |fo-table| for possible values and |gq| for how to format text. + Commas can be inserted for readability. To avoid problems with flags that are added in the future, use the "+=" and "-=" feature of ":set" |add-option-flags|. diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index 53f7166b3d..a8299b31d7 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -2528,8 +2528,9 @@ vim.bo.formatlistpat = vim.o.formatlistpat vim.bo.flp = vim.bo.formatlistpat --- This is a sequence of letters which describes how automatic ---- formatting is to be done. See `fo-table`. Commas can be inserted for ---- readability. +--- formatting is to be done. +--- See `fo-table` for possible values and `gq` for how to format text. +--- Commas can be inserted for readability. --- To avoid problems with flags that are added in the future, use the --- "+=" and "-=" feature of ":set" `add-option-flags`. --- diff --git a/src/nvim/options.lua b/src/nvim/options.lua index 47cb8e7912..40817c8ccc 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -3246,8 +3246,9 @@ return { defaults = { if_true = macros('DFLT_FO_VIM') }, desc = [=[ This is a sequence of letters which describes how automatic - formatting is to be done. See |fo-table|. Commas can be inserted for - readability. + formatting is to be done. + See |fo-table| for possible values and |gq| for how to format text. + Commas can be inserted for readability. To avoid problems with flags that are added in the future, use the "+=" and "-=" feature of ":set" |add-option-flags|. ]=],