From 49573a62b26fed596b8c074d7e613e246fdd3703 Mon Sep 17 00:00:00 2001
From: Martin Perry <martin.perry@bull.com>
Date: Wed, 5 Feb 2014 13:40:42 -0800
Subject: [PATCH] Update the documentation egarding the state of cpu
 frequencies after a step using --cpu-freq completes.

---
 doc/man/man1/srun.1 | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index 455f9f0bfe4..3b4f4d01442 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -405,6 +405,16 @@ confinement (i.e., TaskPlugin=task/affinity or
 TaskPlugin=task/cgroup with the "ConstrainCores" option) is not
 configured, this parameter is ignored.
 
+\fBNOTE\fR: When the step completes, the frequency of each selected cpu 
+is set to its minimum available scaling frequency, to minimize default 
+energy consumption.  The frequency scaling governor for each selected 
+cpu is then reset to its previous type. If that previous 
+type is not \fIuserspace\fR, the frequency may also be changed, depending 
+on the restored governor type. In general, the frequencies of selected 
+cpus before and after a job step is run are unpredictable. If a 
+particular frequency is desired, it should be explicitly requested 
+using \fB\-\-cpu\-freq\fR.
+
 .TP
 \fB\-c\fR, \fB\-\-cpus\-per\-task\fR=<\fIncpus\fR>
 Request that \fIncpus\fR be allocated \fBper process\fR. This may be
-- 
GitLab