Update prereqs.rst with current portability prereq cmds (chapel-lang#…

…23985) This PR updates the `prereqs.rst` example installation commands to install prerequisites. They are generated from a script that uses the commands used in PR chapel-lang#23984. Additionally, updates these installation commands with some notes about incompatibilities e.g., for Alpine we have issue chapel-lang#23414. Reviewed by @brandon-neth - thanks!
arezaii · Dec 4, 2023 · 68b3b7a · 68b3b7a
2 parents de2a5bf + 8348c3b
commit 68b3b7a
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 28 deletions.
diff --git a/doc/rst/usingchapel/prereqs.rst b/doc/rst/usingchapel/prereqs.rst
@@ -72,31 +72,30 @@ Installation
 
   The commands below are automatically generated.
   To regenerate them:
-    cd util/devel/test/singularity
+    cd util/devel/test/apptainer
     ./extract-docs.py
     paste output below
 
 We have used the following commands to install the above prerequisites:
 
-  * Alma Linux 8, 9.0, 9.1, 9.2::
+  * Alma Linux 8, 9.3::
 
       sudo dnf install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git cmake
       sudo dnf install which diffutils
       sudo dnf install llvm-devel clang clang-devel
 
 
-  * Alpine 3.15, 3.17::
+  * Alpine 3.17 (but note `Alpine CHPL_TASKS=qthreads incompatability`_)::
 
       sudo apk add gcc g++ m4 perl python3 python3-dev bash make gawk git cmake
       sudo apk add llvm-dev clang-dev clang-static llvm-static
 
 
-  * Alpine 3.18::
+  * Alpine 3.18 (but note `Alpine CHPL_TASKS=qthreads incompatability`_)::
 
       sudo apk add gcc g++ m4 perl python3 python3-dev bash make gawk git cmake
       sudo apk add llvm15-dev clang15-dev llvm15-static clang15-static
 
-
   * Amazon Linux 2::
 
       sudo yum install git gcc gcc-c++ m4 perl python tcsh bash gcc gcc-c++ perl python python-devel python-setuptools bash make gawk python3 which
@@ -126,7 +125,7 @@ We have used the following commands to install the above prerequisites:
       sudo pacman -S llvm14 clang14
 
 
-  * CentOS 7 Devtoolset 11::
+  * CentOS 7 Devtoolset 11 (but note `CentOS 7 CHPL_LLVM=system incompatability`_)::
 
       sudo yum install centos-release-scl
       sudo yum install devtoolset-11-gcc*
@@ -137,18 +136,11 @@ We have used the following commands to install the above prerequisites:
       sudo echo export CMAKE=cmake3 >> ~/.bashrc
 
 
-  * CentOS Stream 8::
-
-      sudo dnf install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git cmake
-      sudo dnf install which diffutils
-      sudo dnf install llvm-devel clang clang-devel
-
-
-  * CentOS Stream 9::
+  * CentOS Stream 8, 9::
 
       sudo dnf install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git cmake
       sudo dnf install which diffutils
-      sudo dnf install llvm-devel-15.0.7 clang-15.0.7 clang-devel-15.0.7
+      sudo dnf install llvm-devel-16.0.6 clang-16.0.6 clang-devel-16.0.6
 
 
   * Debian 10 "Buster"::
@@ -165,32 +157,32 @@ We have used the following commands to install the above prerequisites:
       sudo apt-get install llvm-dev llvm clang libclang-dev libclang-cpp-dev libedit-dev
 
 
-  * Fedora 34, 35, 36, 37::
+  * Fedora 37, 38, 39, 40 (but note `Fedora CHPL_LLVM=system incompatabilities`_)::
 
       sudo dnf install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git cmake
       sudo dnf install which diffutils
       sudo dnf install llvm-devel clang clang-devel
 
 
-  * FreeBSD 12.2, 12.4, 13.1::
+  * FreeBSD 12.4::
 
       sudo pkg install gcc m4 perl5 python3 bash gmake gawk git pkgconf cmake
       sudo pkg install llvm13
 
 
-  * FreeBSD 13.2::
+  * FreeBSD 13.2, 14.0::
 
       sudo pkg install gcc m4 perl5 python3 bash gmake gawk git pkgconf cmake
       sudo pkg install llvm
 
 
-  * OpenSuse Leap 15.3, 15.4, 15.5::
+  * OpenSuse Leap 15.4, 15.5::
 
       sudo zypper install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git pkg-config cmake
       sudo zypper install llvm-devel clang-devel clang
 
 
-  * Rocky Linux 8, 9.0, 9.1, 9.2::
+  * Rocky Linux 8, 9.3::
 
       sudo dnf install gcc gcc-c++ m4 perl python3 python3-devel bash make gawk git cmake
       sudo dnf install which diffutils
@@ -208,15 +200,35 @@ We have used the following commands to install the above prerequisites:
       sudo apt-get install llvm-12-dev llvm-12 llvm-12-tools clang-12 libclang-12-dev libclang-cpp12-dev libedit-dev
 
 
-  * Ubuntu 22.04 "Jammy Jellyfish"::
+  * Ubuntu 22.04 "Jammy Jellyfish", 23.10 "Mantic Minotaur"::
 
       sudo apt-get update
       sudo apt-get install gcc g++ m4 perl python3 python3-dev bash make mawk git pkg-config cmake
       sudo apt-get install llvm-dev llvm clang libclang-dev libclang-cpp-dev libedit-dev
 
 
-  * Ubuntu 22.10 "Kinetic Kudu"::
+Compatability Notes
+-------------------
 
-      sudo apt-get update
-      sudo apt-get install gcc g++ m4 perl python3 python3-dev bash make mawk git pkg-config cmake
-      sudo apt-get install llvm-14-dev llvm-14 llvm-14-tools clang-14 libclang-14-dev libclang-cpp14-dev libedit-dev
+Alpine CHPL_TASKS=qthreads incompatability
+++++++++++++++++++++++++++++++++++++++++++
+
+Qthreads does not currently build on Alpine, although Chapel does
+work on Alpine with the quickstart configuration or ``CHPL_TASKS=fifo``.
+
+CentOS 7 CHPL_LLVM=system incompatability
++++++++++++++++++++++++++++++++++++++++++
+
+CentOS 7 does not include a new enough LLVM release to work with
+``CHPL_LLVM=system``. ``CHPL_LLVM=bundled`` or ``CHPL_LLVM=none`` are
+available as alternatives.
+
+Fedora CHPL_LLVM=system incompatabilities
++++++++++++++++++++++++++++++++++++++++++
+
+Fedora only includes a single version of ``clang``. As
+a result, ``CHPL_LLVM=system`` only works on Fedora releases that have a
+version of ``clang`` that Chapel supports. In particular,
+``CHPL_LLVM=system`` does not work on the newest versions of Fedora.
+``CHPL_LLVM=bundled`` or ``CHPL_LLVM=none`` are available as
+alternatives.
diff --git a/util/devel/test/apptainer/extract-docs.py b/util/devel/test/apptainer/extract-docs.py
@@ -145,9 +145,6 @@ def extract_vfile_commands(vfile):
         if "nix" in subpath:
             continue # skip these configurations
                      # (not sure how useful this is)
-        if ("fedora-38" in subpath or
-            "fedora-39" in subpath):
-            continue # skip due to not having working LLVM dependency right now
         if "generic-x32-debian11" in subpath:
             continue # skip this one, redudant with other debian ones