Skip to content

Commit

Permalink
Fix autogenerated links to OpenMPI/MPICH docs
Browse files Browse the repository at this point in the history
OpenMPI docs are hosted on a new website, and the docs for all the `*_c`
functions are not available for that this MPI library.  Also, MPICH docstrings
are available at the moment for most functions only in the v4.0 website, not
v4.1+.
  • Loading branch information
giordano committed Aug 6, 2024
1 parent 1872411 commit a4e5a0b
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions src/MPI.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,27 @@ end


function _doc_external(fname)
"""
- `$fname` man page: [OpenMPI](https://www.open-mpi.org/doc/current/man3/$fname.3.php), [MPICH](https://www.mpich.org/static/docs/latest/www3/$fname.html)
"""
# Ideally we'd like to use the "latest" version of the docs, but MPICH v4.0
# at the moment seems to be the last version with all the docstrings.
mpich = "[MPICH](https://www.mpich.org/static/docs/v4.0/www3/$(fname).html)"
# All the *_c functions are undocumented in OpenMPI website
if !endswith(string(fname), "_c")
openmpi = "[OpenMPI](https://docs.open-mpi.org/en/main/man-openmpi/man3/$(fname).3.html)"
# Few docstrings aren't available for MPICH
if fname in (:MPI_Status_c2f, :MPI_Status_f2c) || startswith(string(fname), "MPI_Type_create_f90_")
return """
- `$fname` man page: $(openmpi)
"""
else
return """
- `$fname` man page: $(openmpi), $(mpich)
"""
end
else
return """
- `$fname` man page: $(mpich)
"""
end
end

"""
Expand Down

0 comments on commit a4e5a0b

Please sign in to comment.