git: 198de88111 - main - [phb][Uses]: Add missing Uses=mpi

Fernando Apesteguía <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=198de88111efbcf4a3454521971065b18509008e

commit 198de88111efbcf4a3454521971065b18509008e
Author:     Fernando Apesteguía <[email protected]>
AuthorDate: 2025-02-17 19:25:17 +0000
Commit:     Fernando Apesteguía <[email protected]>
CommitDate: 2025-02-21 16:23:42 +0000

    [phb][Uses]: Add missing Uses=mpi
    
    Approved by:            thierry@ (maintainer)
    Differential Revision:  https://reviews.freebsd.org/D49036
---
 .../en/books/porters-handbook/uses/_index.adoc     | 43 ++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index 61a2de96b4..2e4c2b13e4 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -1517,6 +1517,49 @@ package:x11-toolkits/lesstif[] as dependency instead of package:x11-toolkits/ope
 Similarly setting `WANT_OPEN_MOTIF_DEVEL` in [.filename]#make.conf# will add a
 dependency on package:x11-toolkits/open-motif-devel[]
 
+[[uses-mpi]]
+== `mpi`
+
+Possible arguments: `mpich` (default), `openmpi`
+
+Provide support for ports depending on `MPI`.
+
+If the `mpich` argument is provided a dependency on package:net/mpich[] is added
+to the port.
+
+If the `openmpi` argument is provided a dependency on package:net/openmpi[] is
+added to the port.
+
+The ports framework provides the following variables that can be read by the port:
+
+`MPI_LIBS`::
+Libraries needed to link programs using `MPI`.
+
+`MPI_CFLAGS`::
+Compiler flags necessary to build programs using `MPI`.
+
+`MPICC`::
+Location of the `mpicc` executable. Default: [.filename]#${MPI_HOME}/bin/mpicc#.
+
+`MPICXX`::
+Location of the `mpicxx` executable. Default: [.filename]#${MPI_HOME}/bin/mpicxx#.
+
+`MPIF90`::
+Location of the `mpif90` executable. Default: [.filename]#${MPI_HOME}/bin/mpif90#.
+
+`MPIFC`::
+Same as above.
+
+`MPI_HOME`::
+Installation directory of `MPI`. Defaults to `${LOCALBASE}` for `MPICH`.
+
+`MPIEXEC`::
+Location of the `mpiexec` executable. Default: [.filename]#${MPI_HOME}/bin/mpiexec#.
+
+`MPIRUN`::
+Location of the `mpirun` executable. Default: [.filename]#${MPI_HOME}/bin/mpirun#.
+
+
 [[uses-ncurses]]
 == `ncurses`
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.