Merge pull request #5316 from rhc54/topic/man

Update man and help output for new binding option

orte/mca/schizo/ompi/schizo_ompi.c

@@ -337,7 +337,7 @@ static opal_cmd_line_init_t cmd_line_init[] = {
       /* Binding options */
     { "hwloc_base_binding_policy", '\0', NULL, "bind-to", 1,
       &orte_cmd_options.binding_policy, OPAL_CMD_LINE_TYPE_STRING,
-      "Policy for binding processes. Allowed values: none, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board (\"none\" is the default when oversubscribed, \"core\" is the default when np<=2, and \"socket\" is the default when np>2). Allowed qualifiers: overload-allowed, if-supported", OPAL_CMD_LINE_OTYPE_BINDING },
+      "Policy for binding processes. Allowed values: none, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, cpuset (\"none\" is the default when oversubscribed, \"core\" is the default when np<=2, and \"socket\" is the default when np>2). Allowed qualifiers: overload-allowed, if-supported, ordered", OPAL_CMD_LINE_OTYPE_BINDING },
 
     /* backward compatiblity */
     { "hwloc_base_bind_to_core", '\0', "bind-to-core", "bind-to-core", 0,

orte/tools/orterun/orterun.1in

@@ -366,7 +366,7 @@ For process binding:
 .TP
 .B --bind-to \fR<foo>\fP
 Bind processes to the specified object, defaults to \fIcore\fP. Supported options
-include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, and none.
+include slot, hwthread, core, l1cache, l2cache, l3cache, socket, numa, board, cpuset, and none.
 .
 .TP
 .B -cpus-per-proc\fR,\fP --cpus-per-proc \fR<#perproc>\fP
@@ -1149,6 +1149,15 @@ cause the process to be bound to the processors that share a single L3
 cache within that socket.
 .
 .PP
+Alternatively, processes can be assigned to processors based on
+their local rank on a node using the \fI--bind-to cpuset:ordered\fP option
+with an associated \fI--cpu-list "0,2,5"\fP. This directs that the first
+rank on a node be bound to cpu0, the second rank on the node be bound
+to cpu1, and the third rank on the node be bound to cpu5. Note that an
+error will result if more processes are assigned to a node than cpus
+are provided.
+.
+.PP
 To help balance loads, the binding directive uses a round-robin method when binding to
 levels lower than used in the mapper. For example, consider the case where a job is
 mapped to the socket level, and then bound to core. Each socket will have multiple cores,