From 594c034a13a6ad8f5deb34aa2ee76264dabf2dbd Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Thu, 14 Nov 2002 18:49:42 +0000
Subject: [PATCH] Code beautification, comment enhancement, no logic changes.
---
src/api/cancel.c | 2 +-
src/api/config_info.c | 11 +++++++++--
2 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/src/api/cancel.c b/src/api/cancel.c
index 30d4dd9ed65..f555daa2b9d 100644
--- a/src/api/cancel.c
+++ b/src/api/cancel.c
@@ -35,7 +35,7 @@
#include <src/api/slurm.h>
#include <src/common/slurm_protocol_api.h>
-/* slurm_cancel_job - cancel a job and all of its steps */
+/* slurm_cancel_job - cancel an existing job and all of its steps */
int
slurm_cancel_job ( uint32_t job_id )
{
diff --git a/src/api/config_info.c b/src/api/config_info.c
index 6ba70064170..5234e374466 100644
--- a/src/api/config_info.c
+++ b/src/api/config_info.c
@@ -33,7 +33,10 @@
#include <src/api/slurm.h>
#include <src/common/slurm_protocol_api.h>
-/* slurm_print_ctl_conf - output the contents of Slurm's configuration message */
+/*
+ * slurm_print_ctl_conf - output the contents of slurm control configuration message
+ * as loaded using slurm_load_ctl_conf
+ */
void slurm_print_ctl_conf ( FILE* out, slurm_ctl_conf_info_msg_t * slurm_ctl_conf_ptr )
{
char time_str[16];
@@ -66,7 +69,11 @@ void slurm_print_ctl_conf ( FILE* out, slurm_ctl_conf_info_msg_t * slurm_ctl_con
fprintf(out, "TmpFS = %s\n", slurm_ctl_conf_ptr->tmp_fs);
}
-/* slurm_load_ctl_conf - issue RPC to get Slurm configuration information if changed since update_time */
+/*
+ * slurm_load_ctl_conf - issue RPC to get slurm controlconfiguration information
+ * if changed since update_time
+ * NOTE: free the response using slurm_free_ctl_conf
+ */
int
slurm_load_ctl_conf (time_t update_time, slurm_ctl_conf_t **slurm_ctl_conf_ptr )
{
--
GitLab