From 00b792bdb2181f3efe6d6f18cabe85fe3b5357ff Mon Sep 17 00:00:00 2001
From: Morris Jette <jette@schedmd.com>
Date: Tue, 26 Apr 2011 21:23:30 -0700
Subject: [PATCH] select/cray: update documentation, fix whitespace and other
 cosmetic issues

---
 src/plugins/select/cray/basil_interface.c |  2 +-
 src/plugins/select/cray/basil_interface.h | 22 +++++++++++++++++++---
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/src/plugins/select/cray/basil_interface.c b/src/plugins/select/cray/basil_interface.c
index 9568b221e58..b2f44b8d0a8 100644
--- a/src/plugins/select/cray/basil_interface.c
+++ b/src/plugins/select/cray/basil_interface.c
@@ -758,7 +758,7 @@ extern int do_basil_signal(struct job_record *job_ptr, int signal)
 		int rc = basil_signal_apids(resv_id, signal, NULL);
 
 		if (rc)
-			error("could not signal APIDS of resId %u: %s", resv_id,
+			error("could not signal APIDs of resId %u: %s", resv_id,
 				basil_strerror(rc));
 	}
 	return SLURM_SUCCESS;
diff --git a/src/plugins/select/cray/basil_interface.h b/src/plugins/select/cray/basil_interface.h
index 1759796e8d7..71f32313c79 100644
--- a/src/plugins/select/cray/basil_interface.h
+++ b/src/plugins/select/cray/basil_interface.h
@@ -22,16 +22,31 @@
 
 extern int dim_size[3];
 
+/**
+ * struct select_jobinfo - data specific to Cray node selection plugin
+ * @magic:		magic number, must equal %JOBINFO_MAGIC
+ * @reservation_id:	ALPS reservation ID, assigned upon creation
+ * @confirm_cookie:	cluster-wide unique container identifier to
+ *			confirm the ALPS reservation. Should best use
+ *			SGI process aggregate IDs since session IDs
+ *			are not unique across multiple nodes.
+ * @other_jobinfo:	hook into attached, "other" node selection plugin.
+ */
 struct select_jobinfo {
-	uint16_t		magic;		/* magic number */
-	uint32_t		reservation_id;	/* BASIL reservation ID */
+	uint16_t		magic;
+	uint32_t		reservation_id;
 	uint64_t		confirm_cookie;
 	select_jobinfo_t	*other_jobinfo;
 };
 #define JOBINFO_MAGIC		0x8cb3
 
+/**
+ * struct select_nodeinfo - data used for node information
+ * @magic:		magic number, must equal %NODEINFO_MAGIC
+ * @other_nodeinfo:	hook into attached, "other" node selection plugin.
+ */
 struct select_nodeinfo {
-	uint16_t		magic;		/* magic number */
+	uint16_t		magic;
 	select_nodeinfo_t	*other_nodeinfo;
 };
 #define NODEINFO_MAGIC		0x82a3
@@ -49,6 +64,7 @@ static inline int basil_node_ranking(struct node_record *ig, int nore)
 {
 	return SLURM_SUCCESS;
 }
+
 static inline int basil_inventory(void)
 {
 	return SLURM_SUCCESS;
-- 
GitLab