[flang-commits] [flang] Parallel runtime library design doc (PRIF) (PR #76088)

[Dan Bonachea via flang-commits]

https://github.com/bonachea updated https://github.com/llvm/llvm-project/pull/76088

>From 1bc8387b8b10de28f87c04a69d20917dfd0df47a Mon Sep 17 00:00:00 2001
From: Brad Richardson <everythingfunctional at protonmail.com>
Date: Fri, 22 Dec 2023 08:20:53 -0600
Subject: [PATCH 1/2] Add ParallelMultiImageFortranRuntime.md

This document records the runtime interface specification that
will be used for supporting the multi-image parallel features of LLVM flang.

Co-authored-by: Katherine Rasmussen <krasmussen at lbl.gov>
Co-authored-by: Brad Richardson <everythingfunctional at protonmail.com>
Co-authored-by: Damian Rouson <rouson at lbl.gov>
---
 flang/docs/ParallelMultiImageFortranRuntime.md | 16 ++++++++++++++++
 flang/docs/index.md                            |  1 +
 2 files changed, 17 insertions(+)
 create mode 100644 flang/docs/ParallelMultiImageFortranRuntime.md

diff --git a/flang/docs/ParallelMultiImageFortranRuntime.md b/flang/docs/ParallelMultiImageFortranRuntime.md
new file mode 100644
index 00000000000000..51218351f84129
--- /dev/null
+++ b/flang/docs/ParallelMultiImageFortranRuntime.md
@@ -0,0 +1,16 @@
+<!--===- docs/ParallelMultiImageFortranRuntime.md
+  
+   Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+   See https://llvm.org/LICENSE.txt for license information.
+   SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+  
+-->
+
+# Multi-Image Parallel Fortran Runtime
+
+LLVM Flang targets the Parallel Runtime Interface for Fortran (PRIF) for
+runtime support of Fortran's multi-image parallel features.
+
+The current revision of the PRIF specification is here:
+<https://doi.org/10.25344/S4CG6G>
+
diff --git a/flang/docs/index.md b/flang/docs/index.md
index 70478fa0936d0b..a99f7f89909e17 100644
--- a/flang/docs/index.md
+++ b/flang/docs/index.md
@@ -74,6 +74,7 @@ on how to get in touch with us and to learn more about the current status.
    OpenMP-semantics
    OptionComparison
    Overview
+   ParallelMultiImageFortranRuntime
    ParameterizedDerivedTypes
    ParserCombinators
    Parsing

>From 04c5bf1902720bc79d63cd317bb649ba1efb5a05 Mon Sep 17 00:00:00 2001
From: Dan Bonachea <dobonachea at lbl.gov>
Date: Wed, 29 Jan 2025 09:45:15 -0800
Subject: [PATCH 2/2] Reword as suggested in review by @sscalpone

Co-authored-by: Katherine Rasmussen <krasmussen at lbl.gov>
Co-authored-by: Damian Rouson <rouson at lbl.gov>
---
 flang/docs/ParallelMultiImageFortranRuntime.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/flang/docs/ParallelMultiImageFortranRuntime.md b/flang/docs/ParallelMultiImageFortranRuntime.md
index 51218351f84129..8cf0055e5817bf 100644
--- a/flang/docs/ParallelMultiImageFortranRuntime.md
+++ b/flang/docs/ParallelMultiImageFortranRuntime.md
@@ -8,8 +8,10 @@
 
 # Multi-Image Parallel Fortran Runtime
 
-LLVM Flang targets the Parallel Runtime Interface for Fortran (PRIF) for
-runtime support of Fortran's multi-image parallel features.
+
+The Parallel Runtime Interface for Fortran (PRIF) defines an 
+interface designed for LLVM Flang to target implementations of 
+Fortran's multi-image parallel features.
 
 The current revision of the PRIF specification is here:
 <https://doi.org/10.25344/S4CG6G>