zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Build System docs: consistent headers (#34047)

Browse Source
This commit is contained in:
Adam J. Stewart 2022-11-23 06:35:55 -06:00 committed by GitHub
parent 55c77d659e
commit 5b3b0130f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/spack/docs/build_systems/cachedcmakepackage.rst
View File

@ -5,9 +5,9 @@
.. _cachedcmakepackage: .. _cachedcmakepackage:
------------------ -----------
CachedCMakePackage CachedCMake
------------------ -----------
The CachedCMakePackage base class is used for CMake-based workflows The CachedCMakePackage base class is used for CMake-based workflows
that create a CMake cache file prior to running ``cmake``. This is that create a CMake cache file prior to running ``cmake``. This is

8
lib/spack/docs/build_systems/cudapackage.rst
View File

@ -5,9 +5,9 @@
.. _cudapackage: .. _cudapackage:
----------- ----
CudaPackage Cuda
----------- ----
Different from other packages, ``CudaPackage`` does not represent a build system. Different from other packages, ``CudaPackage`` does not represent a build system.
Instead its goal is to simplify and unify usage of ``CUDA`` in other packages by providing a `mixin-class <https://en.wikipedia.org/wiki/Mixin>`_. Instead its goal is to simplify and unify usage of ``CUDA`` in other packages by providing a `mixin-class <https://en.wikipedia.org/wiki/Mixin>`_.
@ -80,7 +80,7 @@ standard CUDA compiler flags.
**cuda_flags** **cuda_flags**
This built-in static method returns a list of command line flags This built-in static method returns a list of command line flags
for the chosen ``cuda_arch`` value(s). The flags are intended to for the chosen ``cuda_arch`` value(s). The flags are intended to
be passed to the CUDA compiler driver (i.e., ``nvcc``). be passed to the CUDA compiler driver (i.e., ``nvcc``).

8
lib/spack/docs/build_systems/inteloneapipackage.rst
View File

@ -6,9 +6,9 @@
.. _inteloneapipackage: .. _inteloneapipackage:
==================== ===========
IntelOneapiPackage IntelOneapi
==================== ===========
.. contents:: .. contents::
@ -36,7 +36,7 @@ For more information on a specific package, do::
Intel no longer releases new versions of Parallel Studio, which can be Intel no longer releases new versions of Parallel Studio, which can be
used in Spack via the :ref:`intelpackage`. All of its components can used in Spack via the :ref:`intelpackage`. All of its components can
now be found in oneAPI. now be found in oneAPI.
Examples Examples
======== ========

6
lib/spack/docs/build_systems/intelpackage.rst
View File

@ -5,9 +5,9 @@
.. _intelpackage: .. _intelpackage:
------------ -----
IntelPackage Intel
------------ -----
.. contents:: .. contents::

6
lib/spack/docs/build_systems/pythonpackage.rst
View File

@ -5,9 +5,9 @@
.. _pythonpackage: .. _pythonpackage:
------------- ------
PythonPackage Python
------------- ------
Python packages and modules have their own special build system. This Python packages and modules have their own special build system. This
documentation covers everything you'll need to know in order to write documentation covers everything you'll need to know in order to write

8
lib/spack/docs/build_systems/rocmpackage.rst
View File

@ -5,9 +5,9 @@
.. _rocmpackage: .. _rocmpackage:
----------- ----
ROCmPackage ROCm
----------- ----
The ``ROCmPackage`` is not a build system but a helper package. Like ``CudaPackage``, The ``ROCmPackage`` is not a build system but a helper package. Like ``CudaPackage``,
it provides standard variants, dependencies, and conflicts to facilitate building it provides standard variants, dependencies, and conflicts to facilitate building
@ -25,7 +25,7 @@ This package provides the following variants:
* **rocm** * **rocm**
This variant is used to enable/disable building with ``rocm``. This variant is used to enable/disable building with ``rocm``.
The default is disabled (or ``False``). The default is disabled (or ``False``).
* **amdgpu_target** * **amdgpu_target**

6
lib/spack/docs/build_systems/rpackage.rst
View File

@ -5,9 +5,9 @@
.. _rpackage: .. _rpackage:
-------- --
RPackage R
-------- --
Like Python, R has its own built-in build system. Like Python, R has its own built-in build system.

12
lib/spack/docs/build_systems/sourceforgepackage.rst
View File

@ -5,15 +5,15 @@
.. _sourceforgepackage: .. _sourceforgepackage:
------------------ -----------
SourceforgePackage Sourceforge
------------------ -----------
``SourceforgePackage`` is a ``SourceforgePackage`` is a
`mixin-class <https://en.wikipedia.org/wiki/Mixin>`_. It automatically `mixin-class <https://en.wikipedia.org/wiki/Mixin>`_. It automatically
sets the URL based on a list of Sourceforge mirrors listed in sets the URL based on a list of Sourceforge mirrors listed in
`sourceforge_mirror_path`, which defaults to a half dozen known mirrors. `sourceforge_mirror_path`, which defaults to a half dozen known mirrors.
Refer to the package source Refer to the package source
(`<https://github.com/spack/spack/blob/develop/lib/spack/spack/build_systems/sourceforge.py>`__) for the current list of mirrors used by Spack. (`<https://github.com/spack/spack/blob/develop/lib/spack/spack/build_systems/sourceforge.py>`__) for the current list of mirrors used by Spack.
@ -29,7 +29,7 @@ This package provides a method for populating mirror URLs.
It is decorated with `property` so its results are treated as It is decorated with `property` so its results are treated as
a package attribute. a package attribute.
Refer to Refer to
`<https://spack.readthedocs.io/en/latest/packaging_guide.html#mirrors-of-the-main-url>`__ `<https://spack.readthedocs.io/en/latest/packaging_guide.html#mirrors-of-the-main-url>`__
for information on how Spack uses the `urls` attribute during for information on how Spack uses the `urls` attribute during
fetching. fetching.