diff options
Diffstat (limited to 'lib/spack/docs/build_systems/octavepackage.rst')
| -rw-r--r-- | lib/spack/docs/build_systems/octavepackage.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/lib/spack/docs/build_systems/octavepackage.rst b/lib/spack/docs/build_systems/octavepackage.rst new file mode 100644 index 0000000000..f63089406c --- /dev/null +++ b/lib/spack/docs/build_systems/octavepackage.rst @@ -0,0 +1,52 @@ +.. Copyright 2013-2018 Lawrence Livermore National Security, LLC and other + Spack Project Developers. See the top-level COPYRIGHT file for details. + + SPDX-License-Identifier: (Apache-2.0 OR MIT) + +.. _octavepackage: + +------------- +OctavePackage +------------- + +Octave has its own build system for installing packages. + +^^^^^^ +Phases +^^^^^^ + +The ``OctavePackage`` base class has a single phase: + +#. ``install`` - install the package + +By default, this phase runs the following command: + +.. code-block:: console + + $ octave '--eval' 'pkg prefix <prefix>; pkg install <archive_file>' + + +Beware that uninstallation is not implemented at the moment. After uninstalling +a package via Spack, you also need to manually uninstall it from Octave via +``pkg uninstall <package_name>``. + +^^^^^^^^^^^^^^^^^^^^^^^ +Finding Octave packages +^^^^^^^^^^^^^^^^^^^^^^^ + +Most Octave packages are listed at https://octave.sourceforge.io/packages.php. + +^^^^^^^^^^^^ +Dependencies +^^^^^^^^^^^^ + +Usually, the homepage of a package will list dependencies, i.e. +``Dependencies: Octave >= 3.6.0 struct >= 1.0.12``. The same information should +be available in the ``DESCRIPTION`` file in the root of each archive. + +^^^^^^^^^^^^^^^^^^^^^^ +External Documentation +^^^^^^^^^^^^^^^^^^^^^^ + +For more information on the Octave build system, see: +https://octave.org/doc/v4.4.0/Installing-and-Removing-Packages.html |