Skip to content

Commit

Permalink
FAQ: Add link to >=v5.x docs.open-mpi.org
Browse files Browse the repository at this point in the history
Put a specific notice in the FAQ that it is intended for Open MPI
<=v4.x; anyone looking for >=v5.x docs should go to docs.open-mpi.org.

Signed-off-by: Jeff Squyres <[email protected]>
  • Loading branch information
jsquyres committed Mar 25, 2024
1 parent 3a5d13c commit 27791cf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions includes/faq_engine.inc
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,11 @@ function faqlink($link, $text) {
return "<a href=\"$link\">$text</a>";
}

function faq_for_4x() {
print("<font size=+2><font color=\"red\">This FAQ is for Open MPI v4.x and earlier.</font><br />\n");
print("If you are looking for documentation for Open MPI v5.x and later, please visit <a href=\"https://docs.open-mpi.org/\">docs.open-mpi.org</a>.</font>\n\n<p>");
}

$shell_font = "<font color=\"blue\">";
$shell = "shell$</font>";
$cmd_font = "<font color=\"red\">";
Expand All @@ -133,6 +138,8 @@ function do_menu() {
global $short_titles;
$parent_printed = 0;

faq_for_4x();

print("FAQ categories:\n\n<ul>\n\n");
for ($i = 0; $i < sizeof($titles); ++$i) {
if ("" != $titles[$i]) {
Expand Down Expand Up @@ -196,6 +203,8 @@ function do_category() {
include_once($names[$cat_number] . ".inc");
ompi_set_included($names[$cat_number] . ".inc");

faq_for_4x();

print("<p>Table of contents:</p>\n");

print("<p>\n<ol>\n");
Expand Down

0 comments on commit 27791cf

Please sign in to comment.