Skip to content
Snippets Groups Projects
Commit a8fc5b09 authored by Moe Jette's avatar Moe Jette
Browse files

Remove documentation for defunct API call, slurm_complete_job_step

parent 9f356122
No related branches found
No related tags found
No related merge requests found
...@@ -43,7 +43,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \ ...@@ -43,7 +43,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \
man3/slurm_checkpoint_vacate.3 \ man3/slurm_checkpoint_vacate.3 \
man3/slurm_clear_trigger.3 \ man3/slurm_clear_trigger.3 \
man3/slurm_complete_job.3 \ man3/slurm_complete_job.3 \
man3/slurm_complete_job_step.3 \
man3/slurm_confirm_allocation.3 \ man3/slurm_confirm_allocation.3 \
man3/slurm_create_partition.3 \ man3/slurm_create_partition.3 \
man3/slurm_create_reservation.3 \ man3/slurm_create_reservation.3 \
......
...@@ -290,7 +290,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \ ...@@ -290,7 +290,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \
man3/slurm_checkpoint_vacate.3 \ man3/slurm_checkpoint_vacate.3 \
man3/slurm_clear_trigger.3 \ man3/slurm_clear_trigger.3 \
man3/slurm_complete_job.3 \ man3/slurm_complete_job.3 \
man3/slurm_complete_job_step.3 \
man3/slurm_confirm_allocation.3 \ man3/slurm_confirm_allocation.3 \
man3/slurm_create_partition.3 \ man3/slurm_create_partition.3 \
man3/slurm_create_reservation.3 \ man3/slurm_create_reservation.3 \
......
.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job completion calls" .TH "Slurm API" "3" "March 2009" "Morris Jette" "Slurm job completion calls"
.SH "NAME" .SH "NAME"
slurm_complete_job, slurm_complete_job_step \- Slurm job completion calls slurm_complete_job \- Slurm job completion call
.SH "SYNTAX" .SH "SYNTAX"
.LP .LP
#include <slurm/slurm.h> #include <slurm/slurm.h>
...@@ -9,21 +9,7 @@ int \fBslurm_complete_job\fR ( ...@@ -9,21 +9,7 @@ int \fBslurm_complete_job\fR (
.br .br
uint32_t \fIjob_id\fP, uint32_t \fIjob_id\fP,
.br .br
uint32_t \fIjob_return_code\fP, uint32_t \fIjob_return_code\fP
.br
uint32_t \fIsystem_return_code\fP
.br
);
.LP
int \fBslurm_complete_job_step\fR (
.br
uint32_t \fIjob_id\fP,
.br
uint32_t \fIjob_step_id\fP,
.br
uint32_t \fIjob_return_code\fP,
.br
uint32_t \fIsystem_return_code\fP
.br .br
); );
.SH "ARGUMENTS" .SH "ARGUMENTS"
...@@ -31,26 +17,20 @@ int \fBslurm_complete_job_step\fR ( ...@@ -31,26 +17,20 @@ int \fBslurm_complete_job_step\fR (
.TP .TP
\fIjob_id\fP \fIjob_id\fP
Slurm job id number. Slurm job id number.
.TP
\fIjob_step_id\fp
Slurm job step id number.
.TP .TP
\fIjob_return_code\fP \fIjob_return_code\fP
Highest exit code of any task of the user's application. A non\-zero value is considered as an indication of job failure. Exit code of the program executed.
.TP
\fIsystem_return_code\fP
Highest exit code of any system daemon executing the user's application. A non\-zero value is considered as an indication of failure, such as error setting the job's session ID, error creating a log file, etc.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.LP .LP
\fBslurm_complete_job\fR Note the termination of a job. This function may only be \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. 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.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.LP .LP
On success, zero is returned. On error, \-1 is returned, and Slurm error code On success, zero is returned. On error, \-1 is returned, and Slurm error code
is set appropriately. is set appropriately.
.SH "ERRORS" .SH "ERRORS"
.LP .LP
\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code. \fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
...@@ -73,7 +53,8 @@ which must be linked to your process for use ...@@ -73,7 +53,8 @@ which must be linked to your process for use
(e.g. "cc \-lslurm myprog.c"). (e.g. "cc \-lslurm myprog.c").
.SH "COPYING" .SH "COPYING"
Copyright (C) 2002 The Regents of the University of California. Copyright (C) 2002\-2007 The Regents of the University of California.
Copyright (C) 2008\-2009 Lawrence Livermore National Security.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
CODE\-OCEC\-09\-009. All rights reserved. CODE\-OCEC\-09\-009. All rights reserved.
.LP .LP
......
.so man3/slurm_complete_job.3
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment