hlrs-software-stack/spack
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: git version section title + highlight issues (#42398)

Browse source 
* basic_usage: section title for git versions

* improve highlighting by using a comment instead of invalid syntax
This commit is contained in:
Harmen Stoppels 2024-02-01 09:46:17 +01:00 committed by GitHub
parent 2758fc7e14
commit 922a1983f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/spack/docs/basic_usage.rst
View file

@ -1130,6 +1130,10 @@ A version specifier can also be a list of ranges and specific versions,
separated by commas. For example, ``@1.0:1.5,=1.7.1`` matches any version separated by commas. For example, ``@1.0:1.5,=1.7.1`` matches any version
in the range ``1.0:1.5`` and the specific version ``1.7.1``. in the range ``1.0:1.5`` and the specific version ``1.7.1``.
^^^^^^^^^^^^
Git versions
^^^^^^^^^^^^
For packages with a ``git`` attribute, ``git`` references For packages with a ``git`` attribute, ``git`` references
may be specified instead of a numerical version i.e. branches, tags may be specified instead of a numerical version i.e. branches, tags
and commits. Spack will stage and build based off the ``git`` and commits. Spack will stage and build based off the ``git``

14
lib/spack/docs/environments.rst
View file

@ -472,11 +472,11 @@ a ``packages.yaml`` file) could contain:
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
packages: packages:
all: all:
compiler: [intel] compiler: [intel]
... # ...
This configuration sets the default compiler for all packages to This configuration sets the default compiler for all packages to
``intel``. ``intel``.
@ -822,7 +822,7 @@ directories.
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
view: view:
mpis: mpis:
root: /path/to/view root: /path/to/view
@ -866,7 +866,7 @@ automatically named ``default``, so that
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
view: True view: True
is equivalent to is equivalent to
@ -874,7 +874,7 @@ is equivalent to
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
view: view:
default: default:
root: .spack-env/view root: .spack-env/view
@ -884,7 +884,7 @@ and
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
view: /path/to/view view: /path/to/view
is equivalent to is equivalent to
@ -892,7 +892,7 @@ is equivalent to
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
view: view:
default: default:
root: /path/to/view root: /path/to/view

2
lib/spack/docs/getting_started.rst
View file

@ -623,7 +623,7 @@ Fortran.
compilers: compilers:
- compiler: - compiler:
... # ...
paths: paths:
cc: /usr/bin/clang cc: /usr/bin/clang
cxx: /usr/bin/clang++ cxx: /usr/bin/clang++

2
lib/spack/docs/module_file_support.rst
View file

@ -198,7 +198,7 @@ set by changing the ``roots`` key of the configuration.
my_custom_lmod_modules: my_custom_lmod_modules:
roots: roots:
lmod: /path/to/install/custom/lmod/modules lmod: /path/to/install/custom/lmod/modules
... # ...
This configuration will create two module sets. The default module set This configuration will create two module sets. The default module set
will install its ``tcl`` modules to ``/path/to/install/tcl/modules`` will install its ``tcl`` modules to ``/path/to/install/tcl/modules``

2
lib/spack/docs/pipelines.rst
View file

@ -810,7 +810,7 @@ generated by ``spack ci generate``. You also want your generated rebuild jobs
.. code-block:: yaml .. code-block:: yaml
spack: spack:
... # ...
ci: ci:
pipeline-gen: pipeline-gen:
- build-job: - build-job: