From 207c249d867d79fa6145e901a36269ea292f5ff3 Mon Sep 17 00:00:00 2001 From: "Adam J. Stewart" Date: Fri, 13 Jun 2025 12:50:40 +0000 Subject: [PATCH] Packaging Tutorial: minor updates for ISC25 --- outputs/package-py-files/1.package.py | 4 +-- outputs/package-py-files/2.package.py | 4 +-- outputs/package-py-files/3.package.py | 4 +-- outputs/package-py-files/4.package.py | 4 +-- outputs/package-py-files/5.package.py | 4 +-- outputs/package-py-files/6.package.py | 4 +-- tutorial/examples/packaging/1.package.py | 4 +-- tutorial/examples/packaging/2.package.py | 4 +-- tutorial/examples/packaging/3.package.py | 4 +-- tutorial/examples/packaging/4.package.py | 4 +-- tutorial/examples/packaging/5.package.py | 4 +-- tutorial/examples/packaging/6.package.py | 4 +-- tutorial_packaging.rst | 36 ++++++++++-------------- 13 files changed, 39 insertions(+), 45 deletions(-) diff --git a/outputs/package-py-files/1.package.py b/outputs/package-py-files/1.package.py index 320d966edb..0e00329a5e 100644 --- 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 index facc87c8c0..0894ee9377 100644 --- 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 index c92b2848f8..ecb68d21bb 100644 --- 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 index 79d7896602..42bbfada3e 100644 --- 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 index 75be25b26f..ecec5ee246 100644 --- 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 index 66c8c3a583..bc7f9ebca3 100644 --- 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 index 320d966edb..0e00329a5e 100644 --- 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 index facc87c8c0..0894ee9377 100644 --- 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 index c92b2848f8..ecb68d21bb 100644 --- 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 index 79d7896602..42bbfada3e 100644 --- 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 index 1031cd5efe..8d275a4857 100644 --- 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 index e5e14c56d9..4a8ae0917a 100644 --- 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 index 7a49cae6c1..49ca53baf9 100644 --- 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 - `_. - 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,24 +639,24 @@ The `Packaging Guide `_: - for more information on adding tests that run at build-time and against an installation - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Customizing package-related environments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * `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 `_: - for customizing package and dependency build and run environments + for customizing package and dependency build and run environments. + +~~~~~~~~~~~~~~~~~~~~~~~ +Testing an installation +~~~~~~~~~~~~~~~~~~~~~~~ + +* `Checking an installation + `_: + for more information on adding tests that run at build-time and against an installation. ~~~~~~~~~~~~~~~~~~~~~~~~~ Using other build systems @@ -670,13 +664,13 @@ Using other build systems * `Build Systems `_: - for the full list of built-in build systems + for the full list of built-in build systems. * `Spack Package Build Systems tutorial `_: - for tutorials on common build systems + for tutorials on common build systems. * `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 `_: 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 `_: - for making a package discoverable using the ``spack external find`` command + for making a package discoverable using the ``spack external find`` command.