From 23da11fdcc588fe2dc1421fb15686edccb251dae Mon Sep 17 00:00:00 2001
From: Lenny Verkhovsky <lennyb@voltaire.com>
Date: Tue, 8 Jul 2008 07:56:54 +0000
Subject: [PATCH] add some documentation for mpirun's new --loadbalance option 
 closing #1277

This commit was SVN r18832.
---
 orte/tools/orterun/orterun.1 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/orte/tools/orterun/orterun.1 b/orte/tools/orterun/orterun.1
index 4e1e3d8f05..3de2ab68be 100644
--- a/orte/tools/orterun/orterun.1
+++ b/orte/tools/orterun/orterun.1
@@ -171,6 +171,11 @@ Provide a hostfile to use.
 .
 .
 .TP
+.B -loadbalance\fR,\fP --loadbalance
+Uniform distribution of ranks across all nodes by Round Robin mapper.
+.
+.
+.TP
 .B -machinefile\fR,\fP --machinefile \fR<machinefile>\fP
 Synonym for \fI-hostfile\fP.
 .
@@ -461,6 +466,16 @@ on each slot on a given node before running the executable on other available
 nodes.
 .
 .
+.SS Loadbalance rank allocation
+.
+Uniform distribution of the ranks on all nodes when using Round Robin mapper while retaining byslot rank associations.
+
+ ex :               byslot    bynode   loadbalance
+        node0:      0,1,2,3   0,3,6    0,1,2   
+        node1:      4,5,6     1,4      3,4
+        node2:                2,5      5,6
+.
+.
 .
 .SS Specifying Hosts
 .