From a8fc5b091d1e98f02093549df723816869c972cc Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Mon, 2 Mar 2009 18:40:28 +0000 Subject: [PATCH] Remove documentation for defunct API call, slurm_complete_job_step --- doc/man/Makefile.am | 1 - doc/man/Makefile.in | 1 - doc/man/man3/slurm_complete_job.3 | 37 +++++++------------------- doc/man/man3/slurm_complete_job_step.3 | 1 - 4 files changed, 9 insertions(+), 31 deletions(-) delete mode 100644 doc/man/man3/slurm_complete_job_step.3 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 213efaadf68..e68669d2e00 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -43,7 +43,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \ man3/slurm_checkpoint_vacate.3 \ man3/slurm_clear_trigger.3 \ man3/slurm_complete_job.3 \ - man3/slurm_complete_job_step.3 \ man3/slurm_confirm_allocation.3 \ man3/slurm_create_partition.3 \ man3/slurm_create_reservation.3 \ diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in index ba5fd4e8f45..c995caa03eb 100644 --- a/doc/man/Makefile.in +++ b/doc/man/Makefile.in @@ -290,7 +290,6 @@ man3_MANS = man3/slurm_hostlist_create.3 \ man3/slurm_checkpoint_vacate.3 \ man3/slurm_clear_trigger.3 \ man3/slurm_complete_job.3 \ - man3/slurm_complete_job_step.3 \ man3/slurm_confirm_allocation.3 \ man3/slurm_create_partition.3 \ man3/slurm_create_reservation.3 \ diff --git a/doc/man/man3/slurm_complete_job.3 b/doc/man/man3/slurm_complete_job.3 index 455a8c9d7dd..882d926c0f8 100644 --- a/doc/man/man3/slurm_complete_job.3 +++ b/doc/man/man3/slurm_complete_job.3 @@ -1,6 +1,6 @@ -.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" -slurm_complete_job, slurm_complete_job_step \- Slurm job completion calls +slurm_complete_job \- Slurm job completion call .SH "SYNTAX" .LP #include <slurm/slurm.h> @@ -9,21 +9,7 @@ int \fBslurm_complete_job\fR ( .br uint32_t \fIjob_id\fP, .br - 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 + uint32_t \fIjob_return_code\fP .br ); .SH "ARGUMENTS" @@ -31,26 +17,20 @@ int \fBslurm_complete_job_step\fR ( .TP \fIjob_id\fP Slurm job id number. -.TP -\fIjob_step_id\fp -Slurm job step id number. .TP \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. -.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. +Exit code of the program executed. + .SH "DESCRIPTION" .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. + .SH "RETURN VALUE" .LP On success, zero is returned. On error, \-1 is returned, and Slurm error code is set appropriately. + .SH "ERRORS" .LP \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 (e.g. "cc \-lslurm myprog.c"). .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). CODE\-OCEC\-09\-009. All rights reserved. .LP diff --git a/doc/man/man3/slurm_complete_job_step.3 b/doc/man/man3/slurm_complete_job_step.3 deleted file mode 100644 index 117b5dc5918..00000000000 --- a/doc/man/man3/slurm_complete_job_step.3 +++ /dev/null @@ -1 +0,0 @@ -.so man3/slurm_complete_job.3 -- GitLab