zsh/zdharma-continuum.zinit
1
0
Fork 0
mirror of https://github.com/zdharma-continuum/zinit.git synced 2026-09-10 07:36:38 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update docs for new debug command

Browse source 
Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
This commit is contained in:
Vladislav Doster 2023-05-01 04:59:04 -05:00
parent 930b25ee3c
commit a7e500d091
No known key found for this signature in database
3 changed files with 144 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

153
doc/zsdoc/zinit-additional.zsh.adoc
View file

@ -6,10 +6,13 @@ zinit-additional.zsh - a shell script
Documentation automatically generated with `zshelldoc'
== FUNCTIONS
.zinit-clear-debug-report
+zinit-debug
.zinit-debug-clear
.zinit-debug-report
.zinit-debug-revert
.zinit-debug-start
.zinit-debug-status
.zinit-debug-stop
.zinit-debug-unload
.zinit-service
.zinit-wrap-track-functions
:zinit-tmp-subst-source
@ -20,80 +23,124 @@ Documentation automatically generated with `zshelldoc'
Has 1 line(s). No functions are called (may set up e.g. a hook, a Zle widget bound to a key, etc.).
==== .zinit-clear-debug-report
==== +zinit-debug
____
Forgets dtrace repport gathered up to this moment.
Debug command entry point
____
Has 1 line(s). Calls functions:
Has 35 line(s). Doesn't call other functions.
.zinit-clear-debug-report
`-- zinit-autoload.zsh/.zinit-clear-report-for
Uses feature(s): _setopt_, _zmodload_, _zparseopts_
Called by:
zinit.zsh/zinit
==== .zinit-debug-clear
____
Clear latest debug report
____
Has 7 line(s). Calls functions:
.zinit-debug-clear
|-- zinit-autoload.zsh/.zinit-clear-report-for
`-- zinit.zsh/+zi-log
Called by:
zinit-autoload.zsh/.zinit-unload
zinit.zsh/zinit
==== .zinit-debug-start
==== .zinit-debug-report
____
Starts Dtrace, i.e. session tracking for changes in Zsh state.
____
Has 9 line(s). Calls functions:
.zinit-debug-start
|-- zinit.zsh/+zinit-message
|-- zinit.zsh/.zinit-diff
`-- zinit.zsh/.zinit-tmp-subst-on
Called by:
zinit.zsh/zinit
==== .zinit-debug-stop
____
Stops Dtrace (i.e., session tracking for changes in Zsh state).
____
Has 3 line(s). Calls functions:
.zinit-debug-stop
|-- zinit.zsh/.zinit-diff
`-- zinit.zsh/.zinit-tmp-subst-off
Called by:
zinit.zsh/zinit
==== .zinit-debug-unload
____
Reverts changes detected by dtrace run.
Displays debug report (data recorded in interactive session).
____
Has 6 line(s). Calls functions:
.zinit-debug-unload
|-- zinit-autoload.zsh/.zinit-unload
`-- zinit.zsh/+zinit-message
.zinit-debug-report
|-- zinit-autoload.zsh/.zinit-show-report
`-- zinit.zsh/+zi-log
Uses feature(s): _source_
Called by:
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
zinit.zsh/zinit
==== .zinit-debug-revert
____
Revert changes made during debug mode
____
Has 7 line(s). Calls functions:
.zinit-debug-revert
|-- zinit-autoload.zsh/.zinit-unload
`-- zinit.zsh/+zi-log
Uses feature(s): _source_
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== .zinit-debug-start
____
Start debug mode
____
Has 13 line(s). Calls functions:
.zinit-debug-start
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-diff
`-- zinit.zsh/.zinit-tmp-subst-on
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== .zinit-debug-status
____
Revert changes made during debug mode
____
Has 2 line(s). Calls functions:
.zinit-debug-status
`-- zinit.zsh/+zi-log
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== .zinit-debug-stop
____
Stop debug mode
____
Has 14 line(s). Calls functions:
.zinit-debug-stop
|-- zinit.zsh/+zi-log
|-- zinit.zsh/.zinit-diff
`-- zinit.zsh/.zinit-tmp-subst-off
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== .zinit-service
@ -130,7 +177,7 @@ Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
Has 25 line(s). Calls functions:
:zinit-tmp-subst-source
`-- zinit.zsh/+zinit-message
`-- zinit.zsh/+zi-log
Uses feature(s): _eval_

16
doc/zsdoc/zinit-autoload.zsh.adoc
View file

@ -340,7 +340,7 @@ Has 23 line(s). Calls functions:
Called by:
.zinit-unload
zinit-additional.zsh/.zinit-clear-debug-report
zinit-additional.zsh/.zinit-debug-clear
==== .zinit-compile-uncompile-all
@ -796,7 +796,7 @@ ____
____
Has 67 line(s). Doesn't call other functions.
Has 64 line(s). Doesn't call other functions.
Called by:
@ -1168,9 +1168,7 @@ Has 1 line(s). Calls functions:
|-- .zinit-format-parameter
`-- zinit.zsh/.zinit-any-to-user-plugin
Called by:
zinit.zsh/zinit
Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).
==== .zinit-show-report
@ -1212,6 +1210,7 @@ Called by:
.zinit-show-all-reports
.zinit-show-debug-report
zinit-additional.zsh/.zinit-debug-report
zinit.zsh/zinit
==== .zinit-show-times
@ -1359,7 +1358,7 @@ ____
____
Has 386 line(s). Calls functions:
Has 385 line(s). Calls functions:
.zinit-unload
|-- .zinit-clear-report-for
@ -1377,15 +1376,16 @@ Has 386 line(s). Calls functions:
|-- .zinit-save-set-extendedglob
|-- .zinit-unregister-plugin
|   `-- zinit.zsh/.zinit-any-to-user-plugin
|-- zinit-additional.zsh/.zinit-clear-debug-report
|-- zinit-additional.zsh/.zinit-debug-clear
|-- zinit-side.zsh/.zinit-any-colorify-as-uspl2
|-- zinit.zsh/+zi-log
`-- zinit.zsh/.zinit-any-to-user-plugin
Uses feature(s): _alias_, _bindkey_, _eval_, _setopt_, _unalias_, _unfunction_, _zle_, _zstyle_
Called by:
zinit-additional.zsh/.zinit-debug-unload
zinit-additional.zsh/.zinit-debug-revert
zinit.zsh/.zinit-run-task
zinit.zsh/zinit

55
doc/zsdoc/zinit.zsh.adoc
View file

@ -6,6 +6,7 @@ zinit.zsh - a shell script
Documentation automatically generated with `zshelldoc'
== FUNCTIONS
+zi-log
+zinit-deploy-message
+zinit-message
+zinit-prehelp-usage-message
@ -172,10 +173,7 @@ Has 244 line(s). Calls functions:
|   |   `-- .zinit-any-to-user-plugin
|   |-- .zinit-submit-turbo
|   |-- compinit
|   |-- zinit-additional.zsh/.zinit-clear-debug-report
|   |-- zinit-additional.zsh/.zinit-debug-start
|   |-- zinit-additional.zsh/.zinit-debug-stop
|   |-- zinit-additional.zsh/.zinit-debug-unload
|   |-- zinit-additional.zsh/+zinit-debug
|   |-- zinit-autoload.zsh/.zinit-cdisable
|   |-- zinit-autoload.zsh/.zinit-cenable
|   |-- zinit-autoload.zsh/.zinit-clear-completions
@ -193,7 +191,6 @@ Has 244 line(s). Calls functions:
|   |-- zinit-autoload.zsh/.zinit-self-update
|   |-- zinit-autoload.zsh/.zinit-show-all-reports
|   |-- zinit-autoload.zsh/.zinit-show-completions
|   |-- zinit-autoload.zsh/.zinit-show-debug-report
|   |-- zinit-autoload.zsh/.zinit-show-report
|   |-- zinit-autoload.zsh/.zinit-show-times
|   |-- zinit-autoload.zsh/.zinit-show-zstatus
@ -213,6 +210,30 @@ Uses feature(s): _add-zsh-hook_, _alias_, _autoload_, _bindkey_, _colors_, _expo
_Exports (environment):_ PMSPEC [big]*//* ZPFX [big]*//* ZSH_CACHE_DIR
==== +zi-log
____
Wrapper function for +zinit-message until migrated to +zi-log
____
Has 1 line(s). Calls functions:
+zi-log
`-- +zinit-message
Called by:
zinit-additional.zsh/.zinit-debug-clear
zinit-additional.zsh/.zinit-debug-report
zinit-additional.zsh/.zinit-debug-revert
zinit-additional.zsh/.zinit-debug-start
zinit-additional.zsh/.zinit-debug-status
zinit-additional.zsh/.zinit-debug-stop
zinit-additional.zsh/:zinit-tmp-subst-source
zinit-autoload.zsh/.zinit-unload
==== +zinit-deploy-message
____
@ -234,10 +255,17 @@ Called by:
==== +zinit-message
____
Logging function
____
Has 16 line(s). Doesn't call other functions.
Called by:
+zi-log
+zinit-prehelp-usage-message
.zinit-compdef-clear
.zinit-compdef-replay
@ -248,9 +276,6 @@ Called by:
:zinit-tmp-subst-autoload
Script-Body
zinit
zinit-additional.zsh/.zinit-debug-start
zinit-additional.zsh/.zinit-debug-unload
zinit-additional.zsh/:zinit-tmp-subst-source
zinit-autoload.zsh/.zinit-build-module
zinit-autoload.zsh/.zinit-cd
zinit-autoload.zsh/.zinit-confirm
@ -1578,7 +1603,7 @@ ____
____
Has 566 line(s). Calls functions:
Has 553 line(s). Calls functions:
zinit
|-- +zinit-message
@ -1656,10 +1681,7 @@ Has 566 line(s). Calls functions:
|   `-- .zinit-any-to-user-plugin
|-- .zinit-submit-turbo
|-- compinit
|-- zinit-additional.zsh/.zinit-clear-debug-report
|-- zinit-additional.zsh/.zinit-debug-start
|-- zinit-additional.zsh/.zinit-debug-stop
|-- zinit-additional.zsh/.zinit-debug-unload
|-- zinit-additional.zsh/+zinit-debug
|-- zinit-autoload.zsh/.zinit-cdisable
|-- zinit-autoload.zsh/.zinit-cenable
|-- zinit-autoload.zsh/.zinit-clear-completions
@ -1677,7 +1699,6 @@ Has 566 line(s). Calls functions:
|-- zinit-autoload.zsh/.zinit-self-update
|-- zinit-autoload.zsh/.zinit-show-all-reports
|-- zinit-autoload.zsh/.zinit-show-completions
|-- zinit-autoload.zsh/.zinit-show-debug-report
|-- zinit-autoload.zsh/.zinit-show-report
|-- zinit-autoload.zsh/.zinit-show-times
|-- zinit-autoload.zsh/.zinit-show-zstatus
@ -1818,10 +1839,7 @@ Has 1 line(s). Calls functions:
|   `-- .zinit-any-to-user-plugin
|-- .zinit-submit-turbo
|-- compinit
|-- zinit-additional.zsh/.zinit-clear-debug-report
|-- zinit-additional.zsh/.zinit-debug-start
|-- zinit-additional.zsh/.zinit-debug-stop
|-- zinit-additional.zsh/.zinit-debug-unload
|-- zinit-additional.zsh/+zinit-debug
|-- zinit-autoload.zsh/.zinit-cdisable
|-- zinit-autoload.zsh/.zinit-cenable
|-- zinit-autoload.zsh/.zinit-clear-completions
@ -1839,7 +1857,6 @@ Has 1 line(s). Calls functions:
|-- zinit-autoload.zsh/.zinit-self-update
|-- zinit-autoload.zsh/.zinit-show-all-reports
|-- zinit-autoload.zsh/.zinit-show-completions
|-- zinit-autoload.zsh/.zinit-show-debug-report
|-- zinit-autoload.zsh/.zinit-show-report
|-- zinit-autoload.zsh/.zinit-show-times
|-- zinit-autoload.zsh/.zinit-show-zstatus