Packaging Tutorial: minor updates for ISC25 (#453)

adamjstewart · web-flow · commit 80b91056b6ea · 2025-06-13T14:52:26.000+02:00
diff --git a/outputs/package-py-files/1.package.py b/outputs/package-py-files/1.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/outputs/package-py-files/2.package.py b/outputs/package-py-files/2.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/outputs/package-py-files/3.package.py b/outputs/package-py-files/3.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/outputs/package-py-files/4.package.py b/outputs/package-py-files/4.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/outputs/package-py-files/5.package.py b/outputs/package-py-files/5.package.py
@@ -12,11 +12,11 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
     sanity_check_is_dir = ["bin", "lib", "shar"]
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/outputs/package-py-files/6.package.py b/outputs/package-py-files/6.package.py
@@ -12,11 +12,11 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
     sanity_check_is_dir = ["bin", "lib", "share"]
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/tutorial/examples/packaging/1.package.py b/tutorial/examples/packaging/1.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/tutorial/examples/packaging/2.package.py b/tutorial/examples/packaging/2.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/tutorial/examples/packaging/3.package.py b/tutorial/examples/packaging/3.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/tutorial/examples/packaging/4.package.py b/tutorial/examples/packaging/4.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     version("1.0", sha256="24c706591bdcd84541e19389a9314813ce848035ee877e213d528b184f4b43f9")
 
diff --git a/tutorial/examples/packaging/5.package.py b/tutorial/examples/packaging/5.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     sanity_check_is_dir = ["bin", "lib", "shar"]
 
diff --git a/tutorial/examples/packaging/6.package.py b/tutorial/examples/packaging/6.package.py
@@ -12,9 +12,9 @@ class TutorialMpileaks(AutotoolsPackage):
     homepage = "https://github.com/LLNL/mpileaks"
     url = "https://github.com/LLNL/mpileaks/archive/refs/tags/v1.0.tar.gz"
 
-    maintainers("alecbcs")
+    maintainers("adamjstewart")
 
-    license("BSD", checked_by="alecbcs")
+    license("BSD", checked_by="adamjstewart")
 
     sanity_check_is_dir = ["bin", "lib", "share"]
 
diff --git a/tutorial_packaging.rst b/tutorial_packaging.rst
@@ -12,7 +12,7 @@ Package Creation Tutorial
 
 This tutorial walks you through the steps for creating and debugging a simple Spack package.
 We will develop and debug a package using an iterative approach to gain more experience with additional Spack commands.
-For consistency, we will create the package for ``mpileaks`` (https://github.com/LLNL/mpileaks), which is an MPI debugging tool.
+For consistency, we will create a package for ``mpileaks`` (https://github.com/LLNL/mpileaks), an MPI debugging tool.
 
 ------------------------
 What is a Spack Package?
@@ -62,12 +62,6 @@ Spack's *create* command builds a new package from a template by taking the loca
 * create a package skeleton; and
 * open the file in your editor of choice.
 
-.. note::
-
-   An example of creating a package from software with more available
-   versions can be found at `Creating and Editing Packages
-   <https://spack.readthedocs.io/en/latest/packaging_guide.html#creating-editing-packages>`_.
-
 The ``mpileaks`` source code is available in a tarball in the software's repository (https://github.com/LLNL/mpileaks).
 Spack will look at the contents of the tarball and generate a package when we run ``spack create`` with the URL:
 
@@ -645,38 +639,38 @@ The `Packaging Guide <https://spack.readthedocs.io/en/latest/packaging_guide.htm
 
 Additional information on key topics can be found at the links below.
 
-~~~~~~~~~~~~~~~~~~~~~~~
-Testing an installation
-~~~~~~~~~~~~~~~~~~~~~~~
-
-* `Checking an installation
-  <https://spack.readthedocs.io/en/latest/packaging_guide.html#checking-an-installation>`_:
-  for more information on adding tests that run at build-time and against an installation
-
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Customizing package-related environments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * `Retrieving Library Information
   <https://spack-tutorial.readthedocs.io/en/latest/tutorial_advanced_packaging.html#retrieving-library-information>`_:
-  for supporting unique configuration options needed to locate libraries
+  for supporting unique configuration options needed to locate libraries.
 * `Modifying a Package's Build Environment
   <https://spack-tutorial.readthedocs.io/en/latest/tutorial_advanced_packaging.html#modifying-a-package-s-build-environment>`_:
-  for customizing package and dependency build and run environments
+  for customizing package and dependency build and run environments.
+
+~~~~~~~~~~~~~~~~~~~~~~~
+Testing an installation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* `Checking an installation
+  <https://spack.readthedocs.io/en/latest/packaging_guide.html#checking-an-installation>`_:
+  for more information on adding tests that run at build-time and against an installation.
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 Using other build systems
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * `Build Systems
   <https://spack.readthedocs.io/en/latest/build_systems.html>`_:
-  for the full list of built-in build systems
+  for the full list of built-in build systems.
 * `Spack Package Build Systems tutorial
   <https://spack-tutorial.readthedocs.io/en/latest/tutorial_buildsystems.html>`_:
-  for tutorials on common build systems
+  for tutorials on common build systems.
 * `Multiple Build Systems
   <https://spack.readthedocs.io/en/latest/packaging_guide.html#multiple-build-systems>`_:
-  for a reference on writing packages with multiple build systems
+  for a reference on writing packages with multiple build systems.
 * `Package Class Architecture
   <https://spack.readthedocs.io/en/latest/packaging_guide.html#package-class-architecture>`_:
   for more insight on the inner workings of ``Package`` and ``Builder`` classes.
@@ -690,4 +684,4 @@ Making a package externally detectable
 
 * `Making a package externally discoverable
   <https://spack.readthedocs.io/en/latest/packaging_guide.html#making-a-package-discoverable-with-spack-external-find>`_:
-  for making a package discoverable using the ``spack external find`` command
+  for making a package discoverable using the ``spack external find`` command.
