view scripts/help/vm.m @ 32399:2c3faf776bff

VM: Mark certain VM functions as internal use only. This changeset makes the following naming changes to the VM: * vm_enable, vm_compile, and vm_profile are retained as user-facing functions. * All other VM functions are marked as private / internal use only. Private functions are unlisted in `seealso` tags from `vm.m`, and are removed from the manual. Also `vm()` itself is only mentioned in the manual without the full docstring, which would otherwise mention internal functions as well.
author Arun Giridhar <arungiridhar@gmail.com>
date Mon, 09 Oct 2023 11:02:28 -0400
parents 4ae95cbbd1ab
children 251a5be9a564
line wrap: on
line source

########################################################################
##
## Copyright (C) 2023 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn {} {} vm ()
## Summary of commands related to Octave's virtual machine (VM) evaluator.
##
## For more information on each command and available options use
## @code{help CMD}.
##
## The VM commands available in Octave are:
##
## @table @code
## @item vm_enable
## Switch on or off the VM as a whole.
##
## @item vm_compile
## Compile a specified function to bytecode.
##
## @item vm_profile
## Profile the code running in the VM.
##
## @end table
##
## @noindent
##
## @seealso{vm_enable, vm_compile, vm_profile}
## @end deftypefn

function vm ()
  help ("vm");
endfunction

## Mark file as being tested.  No real test needed for a documentation .m file
%!assert (1)