From 74b2c85b41e15f846bd988c56389483f410419e4 Mon Sep 17 00:00:00 2001
From: Danny Taller <66029857+dtaller@users.noreply.github.com>
Date: Thu, 14 Jan 2021 08:54:58 -0800
Subject: improve documentation for Rocm (hip amd builds) (#20812)

* improve documentation
---
 lib/spack/spack/build_systems/rocm.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/lib/spack/spack/build_systems/rocm.py b/lib/spack/spack/build_systems/rocm.py
index d132b91c0c..21a200e159 100644
--- a/lib/spack/spack/build_systems/rocm.py
+++ b/lib/spack/spack/build_systems/rocm.py
@@ -30,6 +30,8 @@
 #        environment: {}
 #        extra_rpaths: []
 #
+#    It is advisable to replace /rocm/ in the paths above with /rocm-version/
+#    and introduce spec version numbers to ensure reproducible results.
 #
 # 2. hip and its dependencies are currently NOT picked up by spack
 #    automatically, and should therefore be added to packages.yaml by hand:
@@ -37,7 +39,7 @@
 #    in packages.yaml:
 #    hip:
 #      externals:
-#      - spec: hip@3.8.20371-d1886b0b
+#      - spec: hip
 #        prefix: /opt/rocm/hip
 #        extra_attributes:
 #          compilers:
@@ -64,6 +66,9 @@
 #            cxx: /opt/rocm/llvm/bin/clang++
 #      buildable: false
 #
+#    It is advisable to replace /rocm/ in the paths above with /rocm-version/
+#    and introduce spec version numbers to ensure reproducible results.
+#
 # 3. In part 2, DO NOT list the path to hsa as /opt/rocm/hsa ! You want spack
 #    to find hsa in /opt/rocm/include/hsa/hsa.h . The directory of
 #    /opt/rocm/hsa also has an hsa.h file, but it won't be found because spack
-- 
cgit v1.2.3-70-g09d2