From 01c9665f7ca53090e9696c0d8f528b47caeda260 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Fri, 10 Mar 2006 19:42:23 +0000
Subject: [PATCH] Add recommendations and warnings for use of --mem_bind.
---
doc/man/man1/srun.1 | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index 63a6e202a68..3a53f8174bf 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -530,14 +530,15 @@ Affinity/Multi-core Options (when the task/affinity plugin is enabled and
the NUMA memory functions are available):
.TP
\fB\-\-mem_bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
-Bind tasks to memory. Note that the resolution of CPU and memory binding
-may differ on some architectures. For example, CPU binding may be performed
+Bind tasks to memory. \fBNote that the resolution of CPU and memory binding
+may differ on some architectures.\fR For example, CPU binding may be performed
at the level of the cores within a processor while memory binding will
be performed at the level of nodes, where the definition of "nodes"
-may differ from system to system. The use of type "local" is highly
-recommended. If you want greater control, try running a simple test
-code with the options "\-\-cpu_bind=verbose,none \-\-mem_bind=verbose,none"
-to determine the specific configuration.
+may differ from system to system. \fBThe use of any type other than
+"none" or "local" is not recommended.\fR
+If you want greater control, try running a simple test code with the
+options "\-\-cpu_bind=verbose,none \-\-mem_bind=verbose,none" to determine
+the specific configuration.
.RS
.TP
.B q[uiet],
@@ -550,7 +551,7 @@ verbosely report binding before task runs
don't bind tasks to memory (default)
.TP
.B rank
-bind by task rank
+bind by task rank (not recommended)
.TP
.B local
Use memory local to the processor in use
@@ -559,13 +560,14 @@ Use memory local to the processor in use
bind by mapping a node's memory to tasks as specified
where <list> is <cpuid1>,<cpuid2>,...<cpuidN>.
CPU IDs are interpreted as decimal values unless they are preceded
-with '0x' in which case they interpreted as hexadecimal values.
+with '0x' in which case they interpreted as hexadecimal values
+(not recommended)
.TP
.B mask_mem:<list>
bind by setting memory masks on tasks as specified
where <list> is <mask1>,<mask2>,...<maskN>.
memory masks are \fBalways\fR interpreted as hexadecimal values but can be
-preceded with an optional '0x'.
+preceded with an optional '0x' (not recommended)
.RE
To have SLURM always report on the selected memory binding for all srun commands
--
GitLab