summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTamara Dahlgren <35777542+tldahlgren@users.noreply.github.com>2022-10-18 12:11:21 -0700
committerGitHub <noreply@github.com>2022-10-18 21:11:21 +0200
commit13356f3bfa2b5cc6d77def51416bce9413acfd02 (patch)
tree9e2a1ab72ae1df7d2db5716d3da79a94d23797f5
parentc6c5e56ec1adb23c7fe20a51ea721ad40a6570ba (diff)
downloadspack-13356f3bfa2b5cc6d77def51416bce9413acfd02.tar.gz
spack-13356f3bfa2b5cc6d77def51416bce9413acfd02.tar.bz2
spack-13356f3bfa2b5cc6d77def51416bce9413acfd02.tar.xz
spack-13356f3bfa2b5cc6d77def51416bce9413acfd02.zip
Docs: Spack info option updates (#33376)
-rw-r--r--lib/spack/docs/basic_usage.rst2
-rw-r--r--lib/spack/docs/build_systems/inteloneapipackage.rst2
-rw-r--r--lib/spack/docs/packaging_guide.rst33
3 files changed, 27 insertions, 10 deletions
diff --git a/lib/spack/docs/basic_usage.rst b/lib/spack/docs/basic_usage.rst
index 53bd3858e0..b8b758e6ed 100644
--- a/lib/spack/docs/basic_usage.rst
+++ b/lib/spack/docs/basic_usage.rst
@@ -85,7 +85,7 @@ All packages whose names or descriptions contain documentation:
To get more information on a particular package from `spack list`, use
`spack info`. Just supply the name of a package:
-.. command-output:: spack info mpich
+.. command-output:: spack info --all mpich
Most of the information is self-explanatory. The *safe versions* are
versions that Spack knows the checksum for, and it will use the
diff --git a/lib/spack/docs/build_systems/inteloneapipackage.rst b/lib/spack/docs/build_systems/inteloneapipackage.rst
index fe6aea91bb..c16c368dd4 100644
--- a/lib/spack/docs/build_systems/inteloneapipackage.rst
+++ b/lib/spack/docs/build_systems/inteloneapipackage.rst
@@ -32,7 +32,7 @@ oneAPI packages or use::
For more information on a specific package, do::
- spack info <package-name>
+ spack info --all <package-name>
Intel no longer releases new versions of Parallel Studio, which can be
used in Spack via the :ref:`intelpackage`. All of its components can
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst
index 5662c3c3f2..556dde31e8 100644
--- a/lib/spack/docs/packaging_guide.rst
+++ b/lib/spack/docs/packaging_guide.rst
@@ -3369,27 +3369,44 @@ The name and order in which the phases will be executed can be obtained either r
docs at :py:mod:`~.spack.build_systems`, or using the ``spack info`` command:
.. code-block:: console
- :emphasize-lines: 13,14
+ :emphasize-lines: 26-27
- $ spack info m4
- AutotoolsPackage: m4
- Homepage: https://www.gnu.org/software/m4/m4.html
+ $ spack info --phases m4
+ AutotoolsPackage: m4
+
+ Description:
+ GNU M4 is an implementation of the traditional Unix macro processor.
+
+ Homepage: https://www.gnu.org/software/m4/m4.html
+
+ Preferred version:
+ 1.4.19 https://ftpmirror.gnu.org/m4/m4-1.4.19.tar.gz
Safe versions:
- 1.4.17 ftp://ftp.gnu.org/gnu/m4/m4-1.4.17.tar.gz
+ 1.4.19 https://ftpmirror.gnu.org/m4/m4-1.4.19.tar.gz
+ 1.4.18 https://ftpmirror.gnu.org/m4/m4-1.4.18.tar.gz
+ 1.4.17 https://ftpmirror.gnu.org/m4/m4-1.4.17.tar.gz
+
+ Deprecated versions:
+ None
Variants:
- Name Default Description
+ Name [Default] When Allowed values Description
+ ============== ==== ============== ===============================
- sigsegv on Build the libsigsegv dependency
+ sigsegv [on] -- on, off Build the libsigsegv dependency
Installation Phases:
autoreconf configure build install
Build Dependencies:
+ diffutils gnuconfig libsigsegv
+
+ Link Dependencies:
libsigsegv
- ...
+ Run Dependencies:
+ None
Typically, phases have default implementations that fit most of the common cases: