← Back to branch summary

~ubuntu-branches/ubuntu/vivid/slurm-llnl/vivid

« back to all changes in this revision

Viewing changes to doc/man/man3/slurm_complete_job.3

  • Committer: Bazaar Package Importer
  • Author(s): Gennaro Oliva
  • Date: 2009-09-24 23:28:15 UTC
  • mfrom: (1.1.11 upstream) (3.2.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090924232815-enh65jn32q1ebg07
Tags: 2.0.5-1
http://bugs.debian.org/541252
* New upstream release 
* Changed dependecy from lib-mysqlclient15 to lib-mysqlclient 
* Added Default-Start for runlevel 2 and 4 and $remote_fs requirement in
  init.d scripts (Closes: #541252)
* Postinst checks for wrong runlevels 2 and 4 links
* Upgraded to standard version 3.8.3
* Add lintian overrides for missing slurm-llnl-configurator.html in doc
  base registration
* modified postrm scripts to ignore pkill return value in order to avoid
  postrm failure when no slurm process is running
* Checking for slurmctld.pid before cancelling running and pending
  jobs during package removal 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/slurm_complete_job.3
1
 
.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job completion calls"
 
1
.TH "Slurm API" "3" "March 2009" "Morris Jette" "Slurm job completion calls"
2
2
.SH "NAME"
3
 
slurm_complete_job, slurm_complete_job_step \- Slurm job completion calls
 
3
slurm_complete_job \- Slurm job completion call
4
4
.SH "SYNTAX"
5
5
.LP 
6
6
#include <slurm/slurm.h>
9
9
.br 
10
10
        uint32_t \fIjob_id\fP, 
11
11
.br
12
 
        uint32_t \fIjob_return_code\fP,
13
 
.br
14
 
        uint32_t \fIsystem_return_code\fP
15
 
.br 
16
 
);
17
 
.LP
18
 
int \fBslurm_complete_job_step\fR (
19
 
.br 
20
 
        uint32_t \fIjob_id\fP,
21
 
.br 
22
 
        uint32_t \fIjob_step_id\fP,
23
 
.br
24
 
        uint32_t \fIjob_return_code\fP,
25
 
.br
26
 
        uint32_t \fIsystem_return_code\fP
 
12
        uint32_t \fIjob_return_code\fP
27
13
.br 
28
14
);
29
15
.SH "ARGUMENTS"
31
17
.TP 
32
18
\fIjob_id\fP
33
19
Slurm job id number.
34
 
.TP
35
 
\fIjob_step_id\fp
36
 
Slurm job step id number.
37
20
.TP 
38
21
\fIjob_return_code\fP
39
 
Highest exit code of any task of the user's application. A non\-zero value is considered as an indication of job failure.
40
 
.TP 
41
 
\fIsystem_return_code\fP
42
 
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.
 
22
Exit code of the program executed.
 
23
 
43
24
.SH "DESCRIPTION"
44
25
.LP 
45
26
\fBslurm_complete_job\fR Note the termination of a job. This function may only be 
46
27
successfully executed by the job's owner or user root.
47
 
.LP 
48
 
\fBslurm_complete_job_step\fR Note the termination of a job step. This function 
49
 
may only be successfully executed by the job's owner or user root.
 
28
 
50
29
.SH "RETURN VALUE"
51
30
.LP
52
31
On success, zero is returned. On error, \-1 is returned, and Slurm error code 
53
32
is set appropriately.
 
33
 
54
34
.SH "ERRORS"
55
35
.LP
56
36
\fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re\-link your code.
73
53
(e.g. "cc \-lslurm myprog.c").
74
54
 
75
55
.SH "COPYING"
76
 
Copyright (C) 2002 The Regents of the University of California.
 
56
Copyright (C) 2002\-2007 The Regents of the University of California.
 
57
Copyright (C) 2008\-2009 Lawrence Livermore National Security.
77
58
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
78
 
LLNL\-CODE\-402394.
 
59
CODE\-OCEC\-09\-009. All rights reserved.
79
60
.LP
80
61
This file is part of SLURM, a resource management program.
81
62
For details, see <https://computing.llnl.gov/linux/slurm/>.