From 7e376344c854554a1b36f96ba9701d6970f00df0 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Fri, 24 Mar 2006 20:29:30 +0000
Subject: [PATCH] Explain job priority of zero meaning to hold the job.

---
 doc/man/man1/scontrol.1 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/man/man1/scontrol.1 b/doc/man/man1/scontrol.1
index 6c3981b5f51..bfff655cdef 100644
--- a/doc/man/man1/scontrol.1
+++ b/doc/man/man1/scontrol.1
@@ -1,4 +1,4 @@
-.TH SCONTROL "1" "December 2005" "scontrol 1.0" "Slurm components"
+.TH SCONTROL "1" "March 2006" "scontrol 1.0" "Slurm components"
 
 .SH "NAME"
 scontrol \- Used view and modify Slurm configuration and state.
@@ -217,6 +217,9 @@ Set the job's partition to the specified value.
 .TP
 \fIPriority\fP=<number>
 Set the job's priority to the specified value.
+Note that a job priority of zero prevents the job from ever being scheduled.
+By setting a job's priority to zero it is held.
+Set the priority to a non-zero value to permit it to run.
 .TP
 \fINice\fP[=delta]
 Adjust job's priority by the specified value. Default value is 100.
-- 
GitLab