From 129d906f597fd89ce39d0dd70be31ecae4b08bbc Mon Sep 17 00:00:00 2001
From: Moe Jette <jette1@llnl.gov>
Date: Mon, 22 Jul 2002 22:01:36 +0000
Subject: [PATCH] Add description of slurm_complete_job and
 slurm_complete_job_step

---
 doc/man/man3/slurm_error.3 |  4 +++-
 doc/man/man3/slurm_job.3   | 31 +++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/doc/man/man3/slurm_error.3 b/doc/man/man3/slurm_error.3
index 7b938ea9be5..f85ee92b6e1 100644
--- a/doc/man/man3/slurm_error.3
+++ b/doc/man/man3/slurm_error.3
@@ -81,7 +81,9 @@ FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.
 .SH "SEE ALSO"
 .LP 
-\fBslurm_allocate_resources\fR(3), \fBslurm_cancel_job\fR(3), 
+\fBslurm_allocate_resources\fR(3), 
+\fBslurm_cancel_job\fR(3), \fBslurm_cancel_job_step\fR(3), 
+\fBslurm_complete_job\fR(3), \fBslurm_complete_job_step\fR(3), 
 \fBslurm_free_ctl_conf\fR(3), 
 \fBslurm_free_resource_allocation_response_msg\fR(3), \fBslurm_free_job_info\fR(3), 
 \fBslurm_free_key\fR(3), \fBslurm_free_node_info\fR(3), \fBslurm_free_partition_info\fR(3), 
diff --git a/doc/man/man3/slurm_job.3 b/doc/man/man3/slurm_job.3
index cf07c576389..07ef35b2544 100644
--- a/doc/man/man3/slurm_job.3
+++ b/doc/man/man3/slurm_job.3
@@ -22,6 +22,28 @@ int \fBslurm_cancel_job\fR (
 .br 
 );
 .LP
+int \fBslurm_cancel_job_step\fR (
+.br 
+	uint32_t \fIjob_id\fP,
+.br 
+	uint32_t \fIjob_step_id\fP
+.br 
+);
+.LP
+int \fBslurm_complete_job\fR (
+.br 
+	uint32_t \fIjob_id\fP
+.br 
+);
+.LP
+int \fBslurm_complete_job_step\fR (
+.br 
+	uint32_t \fIjob_id\fP,
+.br 
+	uint32_t \fIjob_step_id\fP
+.br 
+);
+.LP
 void \fBslurm_free_resource_allocation_response_msg\fR ( 
 .br 
 	resource_allocation_response_msg_t *\fIslurm_alloc_msg_ptr\fP 
@@ -84,12 +106,21 @@ Specifies the double pointer to the structure to be created and filled with a de
 .TP 
 \fIslurm_submit_msg_ptr\fP
 Specifies the pointer to the structure to be created and filled in by the function \fIslurm_submit_batch_job\fP.
+.TP
+\fIjob_step_id\fp
+Slurm job step id number.
 .SH "DESCRIPTION"
 .LP 
 \fBslurm_allocate_resources\fR Request a resource allocation for a job. If successful, a job entry is created. Always release the response message when no longer required using the function \fBslurm_free_resource_allocation_response_msg\fR.
 .LP 
 \fBslurm_cancel_job\fR Request the cancellation of a running or pending job. This function may only be successfully executed by the job's owner or user root.
 .LP 
+\fBslurm_cancel_job_step\fR Request the cancellation of a running job step. This function may only be successfully executed by the job's owner or user root.
+.LP 
+\fBslurm_complete_job\fR Note the termination of a job. This function may only be successfully executed by the job's owner or user root.
+.LP 
+\fBslurm_complete_job_step\fR Note the termination of a job step. This function may only be successfully executed by the job's owner or user root.
+.LP 
 \fBslurm_free_resource_allocation_response_msg\fR Release the storage generated in response to a call of the function \fBslurm_allocate_resources\fR or \fBslurm_job_will_run\fR.
 .LP 
 \fBslurm_free_submit_response_msg\fR Release the storage generated in response to a call of the function \fBslurm_submit_batch_job\fR.
-- 
GitLab