Skip to content

Commit a76b017

Browse files
committed
Packaging: add VISUAL as alternative to EDITOR based on implementation
Signed-off-by: tldahlgren <dahlgren1@llnl.gov>
1 parent bb89a05 commit a76b017

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

tutorial_packaging.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ Creating the Package File
5252

5353
.. note::
5454

55-
Before proceeding, make sure your ``EDITOR`` environment variable
56-
is set to the name or path of your preferred text editor.
55+
Before proceeding, make sure your ``VISUAL`` or ``EDITOR`` environment variable is set to the name or path of your preferred text editor.
5756

5857

5958
Suppose you want to install software that depends on mpileaks but found Spack did not already have a built-in package for it.
@@ -130,7 +129,7 @@ Adding Package Documentation
130129

131130
First, let's fill in the documentation.
132131

133-
Bring mpileaks' ``package.py`` file back up in your ``$EDITOR`` with the ``spack edit`` command:
132+
Bring mpileaks' ``package.py`` file back up in your editor with the ``spack edit`` command:
134133

135134
.. code-block:: console
136135
@@ -210,7 +209,7 @@ The ``mpileaks`` software relies on three third-party libraries:
210209

211210
Fortunately, all of these dependencies are built-in packages in Spack; otherwise, we would have to create packages for them as well.
212211

213-
Bring mpileaks' ``package.py`` file back up in your ``$EDITOR`` with the ``spack edit`` command:
212+
Bring mpileaks' ``package.py`` file back up with the ``spack edit`` command:
214213

215214
.. code-block:: console
216215
@@ -357,7 +356,7 @@ has a ``prefix`` property containing its installation path.
357356

358357
So let's add the configuration arguments for specifying the paths to the two concrete dependencies in the ``configure_args`` method of our package.
359358

360-
Bring mpileaks' ``package.py`` file back up in your ``$EDITOR`` with the ``spack edit`` command:
359+
Bring mpileaks' ``package.py`` file back up with the ``spack edit`` command:
361360

362361
.. code-block:: console
363362
@@ -411,7 +410,7 @@ Let's add the variant to expect an ``int`` value with a default of ``0``.
411410
Setting the default to ``0`` effectively disables the option.
412411
Change ``configure_args`` to retrieve the value and add the corresponding configure arguments when a non-zero value is provided by the user.
413412

414-
Bring mpileaks' ``package.py`` file back up in your ``$EDITOR`` with the ``spack edit`` command:
413+
Bring mpileaks' ``package.py`` file back up with the ``spack edit`` command:
415414

416415
.. code-block:: console
417416

0 commit comments

Comments
 (0)