Disable build-env-configure; add info-mpileaks.out TODO

Signed-off-by: tldahlgren <dahlgren1@llnl.gov>

Author: tldahlgren

outputs/packaging.sh

@@ -29,7 +29,8 @@ example packaging/checksum-mpileaks-1  "spack checksum tutorial-mpileaks 1.0"
 
 example --expect-error packaging/install-mpileaks-1  "spack install tutorial-mpileaks"
 
-# TODO: Update this output manually since automation fails.
+# TODO: Update info-mpileaks.out output manually since automation fails.
+#
 # This fails ("Error: invalid width -2 (must be > 0)") in CI when preparing
 # variants BUT not when run on the command line.
 #cp "$PROJECT/package-py-files/1.package.py" "$mpileaks_package_py"
@@ -41,12 +42,16 @@ example --expect-error packaging/install-mpileaks-2  "spack install tutorial-mpi
 stage_dir="$(spack location -s tutorial-mpileaks)"
 example packaging/build-output        "cat $stage_dir/spack-build-out.txt"
 
-prefix=$(spack python -c \
-    'import spack.concretize; print(spack.concretize.concretize_one("tutorial-mpileaks").prefix)')
-spack cd tutorial-mpileaks
-echo "configure --prefix=$prefix" | example packaging/build-env-configure "spack build-env tutorial-mpileaks -- bash"
-# Unfortunately cannot use a function since it appears to cause excessive delays
-# in output regeneration.
+# TODO: Update build-env-configure output manually since automation fails.
+#
+# 1. Original approach fails since configure cannot be found.
+#prefix=$(spack python -c \
+#    'import spack.concretize; print(spack.concretize.concretize_one("tutorial-mpileaks").prefix)')
+#spack cd tutorial-mpileaks
+#echo "configure --prefix=$prefix" | example packaging/build-env-configure "spack build-env tutorial-mpileaks -- bash"
+#
+# 2. Using a bash function .. seems to encounter excessive delays on the order
+#    of over 10 minutes when watched in CI
 #run_configure() (
 #    prefix=$(spack python -c \
 #        'import spack.concretize; print(spack.concretize.concretize_one("tutorial-mpileaks").prefix)')

tutorial_packaging.rst

@@ -122,15 +122,15 @@ The areas we need to modify are highlighted in the figure below.
 
 .. tip::
 
-   We generally recommend you use the project-prepared archive url, when available, instead of the ``GitHub``-generated ``Source code (tar.gz)`` url since those tend to be less volatile in the face of ``GitHub`` shasum algorithm changes.
+   We generally recommend you use the project-prepared archive url, when available, instead of the ``GitHub``-generated ``Source code (tar.gz)`` since those tend to be less volatile in the face of ``GitHub`` shasum algorithm changes.
 
    In this case, that would mean using the ``https://github.com/LLNL/mpileaks/releases/download/v1.0/mpileaks-1.0.tar.gz`` url.
    Since the file has special build customizations, the ``sha256`` is different.
    Key among the changes is the presence of ``autogen.sh``, which is a convenience script projects use to customize their Autotools reconfiguration process.
    Consequently, you would replace the more general call to ``autoreconf()`` here with an invocation of the ``autogen.sh`` script.
    An example of setting up and using such a script can be found in the `sos <https://github.com/spack/spack-packages/blob/develop/repos/spack_repo/builtin/packages/sos/package.py>`_ package.
 
-Since we are providing a ``url``, we can `confirm the checksum <https://spack.readthedocs.io/en/latest/packaging_guide_creation.html#checksum-verification>`_, or ``sha256`` calculation.
+Since we are providing a ``url``, we can `confirm the checksum <https://spack.readthedocs.io/en/latest/packaging_guide_creation.html#checksum-verification>`_, or ``sha256``, calculation.
 Exit your editor to return to the command line and use the `spack checksum <https://spack.readthedocs.io/en/latest/packaging_guide_creation.html#spack-checksum>`_ command:
 
 .. literalinclude:: outputs/packaging/checksum-mpileaks-1.out
@@ -196,6 +196,8 @@ It won't help us build the software; however, the information is now available f
 
 .. _info_mpileaks:
 
+.. TODO: The output to info-mpileaks.out must be manually generated.
+
 Let's enter the `spack info <https://spack.readthedocs.io/en/latest/package_fundamentals.html#cmd-spack-info>`_ command for the package:
 
 .. literalinclude:: outputs/packaging/info-mpileaks.out