From f4473b983f5d8cf09e491c2dc2a15f751ea12c63 Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Mon, 16 Dec 2002 18:52:14 +0000
Subject: [PATCH] Describe job priority of zero being equivalent to job hold.

---
 src/api/slurm.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/api/slurm.h b/src/api/slurm.h
index e8479004900..9f880230cd1 100644
--- a/src/api/slurm.h
+++ b/src/api/slurm.h
@@ -142,8 +142,9 @@ typedef struct job_descriptor {	/* For submit, allocate, and update requests */
 				 * default=0 */
 	char *partition;	/* name of requested partition, 
 				 * default in SLURM config */
-	uint32_t priority;	/* relative priority of the job, explicitly 
-				 * set only for user root */
+	uint32_t priority;	/* relative priority of the job,  
+				 * explicitly set only for user root, 
+				 * 0 == held (don't initiate) */
 	char *req_nodes;	/* comma separated list of required nodes
 				 * default NONE */
 	uint16_t shared;	/* 1 if job can share nodes with other jobs,
-- 
GitLab