From e2c12d8e1f00bef36f57e63b9589a3de0805b172 Mon Sep 17 00:00:00 2001
From: Brian Christiansen <brian@schedmd.com>
Date: Mon, 9 Feb 2015 11:43:59 -0800
Subject: [PATCH] Update docs for --hint=nomultithread.

Only supported with task/affinity plugin.
---
 doc/html/core_spec.shtml | 2 +-
 doc/man/man1/salloc.1    | 9 +++++----
 doc/man/man1/sbatch.1    | 9 +++++----
 doc/man/man1/srun.1      | 9 +++++----
 4 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/doc/html/core_spec.shtml b/doc/html/core_spec.shtml
index ca754e5fba6..1d81ffdf79e 100644
--- a/doc/html/core_spec.shtml
+++ b/doc/html/core_spec.shtml
@@ -74,7 +74,7 @@ In addition, specialized resources should be configured in slurm.conf on the
 node specification line using the <i>CoreSpecCount</i> or <i>CPUSpecList</i>
 option to identify the CPUs to reserve.
 The <i>MemSpecLimit</i> option can be used to reserve memory.
-These resource will be reserved using Linux cgroups.
+These resources will be reserved using Linux cgroups.
 Users wanting a different number of specialized cores should use the
 <i>--core-spec</i> option as described above.</p>
 
diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1
index 70e1b1840ec..15a180b144f 100644
--- a/doc/man/man1/salloc.1
+++ b/doc/man/man1/salloc.1
@@ -365,20 +365,21 @@ Display help information and exit.
 
 .TP
 \fB\-\-hint\fR=<\fItype\fR>
-Bind tasks according to application hints
+Bind tasks according to application hints.
 .RS
 .TP
 .B compute_bound
 Select settings for compute bound applications:
-use all cores in each socket, one thread per core
+use all cores in each socket, one thread per core.
 .TP
 .B memory_bound
 Select settings for memory bound applications:
-use only one core in each socket, one thread per core
+use only one core in each socket, one thread per core.
 .TP
 .B [no]multithread
 [don't] use extra threads with in-core multi-threading
-which can benefit communication intensive applications
+which can benefit communication intensive applications.
+Only supported with the task/affinity plugin.
 .TP
 .B help
 show this help message
diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1
index 37b1b48ef6b..79ed98c0839 100644
--- a/doc/man/man1/sbatch.1
+++ b/doc/man/man1/sbatch.1
@@ -429,20 +429,21 @@ Display help information and exit.
 
 .TP
 \fB\-\-hint\fR=<\fItype\fR>
-Bind tasks according to application hints
+Bind tasks according to application hints.
 .RS
 .TP
 .B compute_bound
 Select settings for compute bound applications:
-use all cores in each socket, one thread per core
+use all cores in each socket, one thread per core.
 .TP
 .B memory_bound
 Select settings for memory bound applications:
-use only one core in each socket, one thread per core
+use only one core in each socket, one thread per core.
 .TP
 .B [no]multithread
 [don't] use extra threads with in-core multi-threading
-which can benefit communication intensive applications
+which can benefit communication intensive applications.
+Only supported with the task/affinity plugin.
 .TP
 .B help
 show this help message
diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index 9abca305f27..dfe35da6fac 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -622,20 +622,21 @@ Display help information and exit.
 
 .TP
 \fB\-\-hint\fR=<\fItype\fR>
-Bind tasks according to application hints
+Bind tasks according to application hints.
 .RS
 .TP
 .B compute_bound
 Select settings for compute bound applications:
-use all cores in each socket, one thread per core
+use all cores in each socket, one thread per core.
 .TP
 .B memory_bound
 Select settings for memory bound applications:
-use only one core in each socket, one thread per core
+use only one core in each socket, one thread per core.
 .TP
 .B [no]multithread
 [don't] use extra threads with in-core multi-threading
-which can benefit communication intensive applications
+which can benefit communication intensive applications.
+Only supported with the task/affinity plugin.
 .TP
 .B help
 show this help message
-- 
GitLab