From e23b7335f0c3662d768615119c384603ab4cf363 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Mon, 8 Aug 2005 16:14:49 +0000
Subject: [PATCH] Fix mpi documentation to specify mpich-gm instead of mpichgm

---
 doc/man/man1/srun.1       | 14 +++++++++-----
 doc/man/man5/slurm.conf.5 |  6 +++---
 etc/slurm.conf.example    |  2 +-
 src/srun/opt.c            |  1 +
 4 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index ae67cc9e3ed..284246e663b 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -1,6 +1,6 @@
 \." $Id$
 .\"
-.TH SRUN "1" "June 2005" "srun 0.5" "slurm components"
+.TH SRUN "1" "August 2005" "srun 0.6" "slurm components"
 .SH "NAME"
 srun \- run parallel jobs
 .SH SYNOPSIS
@@ -184,15 +184,19 @@ procedures.
 .B list
 Lists avaliable mpi types to choose from.
 .TP
-.B mpich-gm
+.B lam
+Initiates one 'lamd' process per node and establishes necessary
+environment variables for LAM/MPI.
+.TP
+.B mpich\-gm
 For use with Myrinet.
 .TP
 .B mvapich
 For use with Infiniband.
 .TP
-.B lam
-Initiates one 'lamd' process per node and establishes necessary 
-environment variables for LAM/MPI.
+.B none
+No special MPI processing. This is the default and works with 
+many other versions of MPI.
 .RE
 .TP
 \fB\-\-jobid\fR=\fIid\fR
diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5
index bef4ee1ffa4..349bd081293 100644
--- a/doc/man/man5/slurm.conf.5
+++ b/doc/man/man5/slurm.conf.5
@@ -218,11 +218,11 @@ its memory or other resources. The default value is 300 seconds.
 A value of zero prevents any job record purging.
 May not exceed 65534.
 .TP
-\fpMpiDefault\fR
+\fBMpiDefault\fR
 Identifies the default type of MPI to be used. 
 Srun may override this configuration parameter in any case.
-Currently supported versions include: lam, mpichgm, mvapich, 
-and none (default, which works for most other versions of MPI).
+Currently supported versions include: lam, mpich\-gm, mvapich, 
+and none (default, which works for many other versions of MPI).
 .TP
 \fBMpichGmDirectSupport\fR
 If set to "1", srun handles executable files linked with the MPICH-GM 
diff --git a/etc/slurm.conf.example b/etc/slurm.conf.example
index 06599020d2b..239b41f23ff 100644
--- a/etc/slurm.conf.example
+++ b/etc/slurm.conf.example
@@ -351,7 +351,7 @@ JobAcctType=jobacct/none
 #    "MpiDefault"	: define the default type of MPI to be used. If
 #			  srun does not specify another value, slurm will 
 #			  establish the environment for this mpi to execute.
-#			  Currently supported values are lam, mpichgm, mvapich,
+#			  Currently supported values are lam, mpich-gm, mvapich,
 #                         and none (default, which works for most other versions
 #                         of MPI).
 #
diff --git a/src/srun/opt.c b/src/srun/opt.c
index c7a70209ddc..e880f506cb5 100644
--- a/src/srun/opt.c
+++ b/src/srun/opt.c
@@ -1573,6 +1573,7 @@ static void _help(void)
 "  -P, --dependency=jobid      defer job until specified jobid completes\n"
 "  -U, --account=name          charge job to specified account\n"
 "      --propagate[=rlimits]   propagate all [or specific list of] rlimits\n"
+"      --mpi=type              specifies version of MPI to use\n"
 "\n"
 "Allocate only:\n"
 "  -A, --allocate              allocate resources and spawn a shell\n"
-- 
GitLab