commit 1f7f83ff678de4ba2acaefafb9fbd1d69dd2abe3
parent 852954ff6d96adce0158f74ca494fdcef3aa1921
Author: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Oct 2024 07:32:49 +0800
vim-patch:partial:8.2.4712: only get profiling information after exiting
https://github.com/vim/vim/commit/18ee0f603ebd3c091f6d2ab88e652fda32821048
Doc updates only.
Cherry-pick profiling doc change from patch 8.2.2400.
Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
Diffstat:
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git 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
+ 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.
: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() ~
