aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2024-10-17 08:14:58 +0800
committerGitHub <noreply@github.com>2024-10-17 08:14:58 +0800
commitfae4d3fa1b65b7632d048cad2a1beb7afaa61c21 (patch)
tree4f8ae3cbbf00c7d1bf8f998bf8a4d5139d591ba3 /runtime/doc
parent852954ff6d96adce0158f74ca494fdcef3aa1921 (diff)
parentc89150241d52ac70dd5bf0f4f8cb90902a7ccf6c (diff)
downloadrneovim-fae4d3fa1b65b7632d048cad2a1beb7afaa61c21.tar.gz
rneovim-fae4d3fa1b65b7632d048cad2a1beb7afaa61c21.tar.bz2
rneovim-fae4d3fa1b65b7632d048cad2a1beb7afaa61c21.zip
Merge pull request #30836 from zeertzjq/vim-4bfb899
vim-patch: doc updates
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/builtin.txt2
-rw-r--r--runtime/doc/options.txt4
-rw-r--r--runtime/doc/repeat.txt33
3 files changed, 26 insertions, 13 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 1022565b87..1f1d7488e1 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -11705,7 +11705,7 @@ wildmenumode() *wildmenumode()*
For example to make <c-j> work like <down> in wildmode, use: >vim
cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
<
- (Note, this needs the 'wildcharm' option set appropriately).
+ (Note: this needs the 'wildcharm' option set appropriately).
Return: ~
(`any`)
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 3a6f93ae01..5dc1643ee3 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6763,7 +6763,9 @@ A jump table for the options with a short description can be found at |Q_op|.
window. This happens only when the 'title' option is on.
When this option contains printf-style '%' items, they will be
- expanded according to the rules used for 'statusline'.
+ expanded according to the rules used for 'statusline'. If it contains
+ an invalid '%' format, the value is used as-is and no error or warning
+ will be given when the value is set.
This option cannot be set in a modeline when 'modelineexpr' is off.
Example: >vim
diff --git a/runtime/doc/repeat.txt b/runtime/doc/repeat.txt
index 521d690d93..abeefb980e 100644
--- a/runtime/doc/repeat.txt
+++ b/runtime/doc/repeat.txt
@@ -967,21 +967,24 @@ For example, to profile the one_script.vim script file: >
:prof[ile] start {fname} *:prof* *:profile* *E750*
- Start profiling, write the output in {fname} upon exit.
+ Start profiling, write the output in {fname} upon exit or when
+ a `:profile stop` or `:profile dump` command is invoked.
"~/" and environment variables in {fname} will be expanded.
If {fname} already exists it will be silently overwritten.
The variable |v:profiling| is set to one.
:prof[ile] stop
- Write the logfile and stop profiling.
+ Write the collected profiling information to the logfile and
+ stop profiling. You can use the `:profile start` command to
+ clear the profiling statistics and start profiling again.
:prof[ile] pause
- Don't profile until the following ":profile continue". Can be
- used when doing something that should not be counted (e.g., an
- external command). Does not nest.
+ Stop profiling until the next `:profile continue` command.
+ Can be used when doing something that should not be counted
+ (e.g., an external command). Does not nest.
:prof[ile] continue
- Continue profiling after ":profile pause".
+ Continue profiling after `:profile pause`.
:prof[ile] func {pattern}
Profile function that matches the pattern {pattern}.
@@ -999,16 +1002,24 @@ For example, to profile the one_script.vim script file: >
won't work.
:prof[ile] dump
- Don't wait until exiting Vim and write the current state of
- profiling to the log immediately.
+ Write the current state of profiling to the logfile
+ immediately. After running this command, Vim continues to
+ collect the profiling statistics.
:profd[el] ... *:profd* *:profdel*
Stop profiling for the arguments specified. See |:breakdel|
- for the arguments.
-
+ for the arguments. Examples: >
+ profdel func MyFunc
+ profdel file MyScript.vim
+ profdel here
You must always start with a ":profile start fname" command. The resulting
-file is written when Vim exits. Here is an example of the output, with line
+file is written when Vim exits. For example, to profile one specific
+function: >
+ profile start /tmp/vimprofile
+ profile func MyFunc
+
+Here is an example of the output, with line
numbers prepended for the explanation:
1 FUNCTION Test2() ~