From 00d66a2a5bb33f1fb273b0ecc80e94f3b6435733 Mon Sep 17 00:00:00 2001
From: Morris Jette <jette@schedmd.com>
Date: Tue, 5 Aug 2014 08:04:28 -0700
Subject: [PATCH] Added comments

Describe restrictions on specific job and step record purging functions
with respect to "cleaning" flag used for Node Health Check on Cray systems.
---
 src/slurmctld/job_mgr.c  | 5 ++++-
 src/slurmctld/step_mgr.c | 3 ++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/slurmctld/job_mgr.c b/src/slurmctld/job_mgr.c
index fef4591ce75..b7ab77cd91d 100644
--- a/src/slurmctld/job_mgr.c
+++ b/src/slurmctld/job_mgr.c
@@ -7844,7 +7844,10 @@ void purge_old_job(void)
 
 
 /*
- * _purge_job_record - purge specific job record
+ * _purge_job_record - purge specific job record. No testing is performed to
+ *	insure the job records has no active references. Use only for job
+ *	records that were never fully operational (e.g. WILL_RUN test, failed
+ *	job load, failed job create, etc.).
  * IN job_id - job_id of job record to be purged
  * RET int - count of job's purged
  * global: job_list - global job table
diff --git a/src/slurmctld/step_mgr.c b/src/slurmctld/step_mgr.c
index 497061843d7..5fae8f45de1 100644
--- a/src/slurmctld/step_mgr.c
+++ b/src/slurmctld/step_mgr.c
@@ -262,7 +262,8 @@ extern void delete_step_records (struct job_record *job_ptr)
 }
 
 /*
- * step_list_purge - Simple purge of a job's step list records.
+ * step_list_purge - Simple purge of a job's step list records. No testing is
+ *	performed to insure the step records has no active references.
  * IN job_ptr - pointer to job table entry to have step records removed
  */
 extern void step_list_purge(struct job_record *job_ptr)
-- 
GitLab