summaryrefslogtreecommitdiff
path: root/lib/spack/docs/getting_started.rst
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2023-04-18 03:42:56 -0700
committerTodd Gamblin <tgamblin@llnl.gov>2023-04-18 16:23:00 -0700
commitb260234faf34b19227e87698bc2a1402c4ea76ac (patch)
treebdb31bd8de13d93356c8a6260a5d1af5e8ad0c52 /lib/spack/docs/getting_started.rst
parent2f30da176228c7a78447f6894e8406ed7b7ff4dd (diff)
downloadspack-b260234faf34b19227e87698bc2a1402c4ea76ac.tar.gz
spack-b260234faf34b19227e87698bc2a1402c4ea76ac.tar.bz2
spack-b260234faf34b19227e87698bc2a1402c4ea76ac.tar.xz
spack-b260234faf34b19227e87698bc2a1402c4ea76ac.zip
editing: add higher-precedence `SPACK_EDITOR` environment variable
Other tools like git support `GIT_EDITOR` which takes higher precedence than the standard `VISUAL` or `EDITOR` variables. This adds similar support for Spack, in the `SPACK_EDITOR` env var. - [x] consolidate editor code from hooks into `spack.util.editor` - [x] add more editor tests - [x] add support for `SPACK_EDITOR` - [x] add a documentation section for controlling the editor and reference it
Diffstat (limited to 'lib/spack/docs/getting_started.rst')
-rw-r--r--lib/spack/docs/getting_started.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst
index 3c847b876e..46bf657d62 100644
--- a/lib/spack/docs/getting_started.rst
+++ b/lib/spack/docs/getting_started.rst
@@ -368,7 +368,8 @@ Manual compiler configuration
If auto-detection fails, you can manually configure a compiler by
editing your ``~/.spack/<platform>/compilers.yaml`` file. You can do this by running
-``spack config edit compilers``, which will open the file in your ``$EDITOR``.
+``spack config edit compilers``, which will open the file in
+:ref:`your favorite editor <controlling-the-editor>`.
Each compiler configuration in the file looks like this: