# HG changeset patch # User Arun Giridhar # Date 1696861546 14400 # Node ID 4ae95cbbd1ab938f2adac37ee7b0d9fa1db30068 # Parent 9281146e836b5a89abb440caae5be8a9b6cbdac6 Backed out changeset fc3f9660d5f2 diff -r 9281146e836b -r 4ae95cbbd1ab libinterp/corefcn/compile.cc --- a/libinterp/corefcn/compile.cc Sun Oct 08 15:41:25 2023 -0400 +++ b/libinterp/corefcn/compile.cc Mon Oct 09 10:25:46 2023 -0400 @@ -85,7 +85,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} vm_clear_cache () -Clear the VM evaluator's internal cache. +Internal function. @end deftypefn */) { @@ -98,6 +98,8 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{prints_trace} =} vm_print_trace ()) +Internal function. + Print a debug trace from the VM. Toggles on or off each call. There has to be a breakpoint set in some file for the trace @@ -116,6 +118,8 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{count} =} __ref_count__ (@var{obj})) +Internal function. + Returns reference count for an object. @end deftypefn */) @@ -134,6 +138,8 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{is_executing} =} vm_is_executing ()) +Internal function. + Returns true if the VM is executing the function calling vm_is_executing (). False otherwise. @@ -162,6 +168,8 @@ @deftypefnx {} {@var{T} =} vm_profile ("info") @deftypefnx {} {} vm_profile +Internal function. + Profile code running in the VM. @table @code @@ -269,6 +277,8 @@ @deftypefn {} {@var{success} =} vm_print_bytecode (@var{fn_name})) @deftypefnx {} {@var{success} =} vm_print_bytecode (@var{fn_handle})) +Internal function. + Prints the bytecode of a function name or function handle, if any. @end deftypefn */) @@ -342,6 +352,8 @@ @deftypefn {} {@var{is_compiled} =} vm_is_compiled (@var{fn_name}) @deftypefnx {} {@var{is_compiled} =} vm_is_compiled (@var{fn_handle}) +Internal function. + Returns true if the specified function name or function handle is compiled. False otherwise. @@ -405,6 +417,8 @@ @deftypefnx {} {@var{success} =} vm_compile (@var{fn_name}, "clear") @deftypefnx {} {@var{success} =} vm_compile (@var{fn_name}, "print") +Internal function. + Compile the specified function to bytecode. The compiled function and its subfunctions will be executed diff -r 9281146e836b -r 4ae95cbbd1ab scripts/help/vm.m --- a/scripts/help/vm.m Sun Oct 08 15:41:25 2023 -0400 +++ b/scripts/help/vm.m Mon Oct 09 10:25:46 2023 -0400 @@ -40,22 +40,22 @@ ## VM user function. Compile a specified function to bytecode. ## ## @item vm_clear_cache -## Clear the cache of already-processed code. +## Internal function. Clear the cache of already-processed code. ## ## @item vm_is_compiled -## Return true if the specified function is compiled. +## VM internal function. Return true if the specified function is compiled. ## ## @item vm_is_executing -## Return true if the VM is executing. +## Internal function. Return true if the VM is executing. ## ## @item vm_print_bytecode -## Print bytecode of specified function. +## Internal function. Print bytecode of specified function. ## ## @item vm_print_trace -## Print a debug trace from the VM. +## Internal function. Print a debug trace from the VM. ## ## @item vm_profile -## Profile the code running in the VM. +## Internal function. Profile the code running in the VM. ## ## @end table ##