Mercurial > octave
changeset 32380:dd9b6f2ae43b
doc: Add new VM functions to vm.m and vectorize.txi
vm.m: Add descriptions for new functions __vm_is_compiled__
and __vm_print_bytecode__
vectorize.txi: Link those two new functions.
| author | Arun Giridhar <arungiridhar@gmail.com> |
|---|---|
| date | Sat, 07 Oct 2023 20:20:07 -0400 |
| parents | 262768aefb8b |
| children | d079a658d9d9 |
| files | doc/interpreter/vectorize.txi scripts/help/vm.m |
| diffstat | 2 files changed, 17 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/vectorize.txi Sat Oct 07 00:50:18 2023 +0200 +++ b/doc/interpreter/vectorize.txi Sat Oct 07 20:20:07 2023 -0400 @@ -667,8 +667,12 @@ @DOCSTRING(__vm_clear_cache__) +@DOCSTRING(__vm_is_compiled__) + @DOCSTRING(__vm_is_executing__) +@DOCSTRING(__vm_print_bytecode__) + @DOCSTRING(__vm_print_trace__) @DOCSTRING(__vm_profile__)
--- a/scripts/help/vm.m Sat Oct 07 00:50:18 2023 +0200 +++ b/scripts/help/vm.m Sat Oct 07 20:20:07 2023 -0400 @@ -30,20 +30,26 @@ ## For more information on each command and available options use ## @code{help CMD}. ## -## The VM commands available in Octave are +## The VM commands available in Octave are: ## ## @table @code ## @item __vm_enable__ -## The main VM user function. Switch on or off the VM as a whole. +## Main VM user function. Switch on or off the VM as a whole. ## ## @item __vm_compile__ -## Another VM user function. Compiles a specified function to bytecode. +## VM user function. Compile a specified function to bytecode. ## ## @item __vm_clear_cache__ -## Internal function. Clears the cache of already-processed code. +## Internal function. Clear the cache of already-processed code. +## +## @item __vm_is_compiled__ +## VM internal function. Return true if the specified function is compiled. ## ## @item __vm_is_executing__ -## Internal function. Returns true if the VM is executing. +## Internal function. Return true if the VM is executing. +## +## @item __vm_print_bytecode__ +## Internal function. Print bytecode of specified function. ## ## @item __vm_print_trace__ ## Internal function. Print a debug trace from the VM. @@ -56,7 +62,8 @@ ## @noindent ## ## @seealso{__vm_enable__, __vm_compile__, __vm_clear_cache__, -## __vm_is_executing__, __vm_print_trace__, __vm_profile__} +## __vm_is_compiled__, __vm_is_executing__, __vm_print_bytecode__, +## __vm_print_trace__, __vm_profile__} ## @end deftypefn function vm ()