Skip to content
Snippets Groups Projects
Commit 58c5f317 authored by Morris Jette's avatar Morris Jette
Browse files

Correct job_submit LUA API documentation

parent 8d9a524c
No related branches found
No related tags found
No related merge requests found
...@@ -93,7 +93,7 @@ not SLURM_SUCESS.<br> ...@@ -93,7 +93,7 @@ not SLURM_SUCESS.<br>
<p class="commandline"> <p class="commandline">
int job_modify(struct job_descriptor *job_desc, struct job_record *job_ptr, int job_modify(struct job_descriptor *job_desc, struct job_record *job_ptr,
uint32_t submit_uid) uint32_t modify_uid)
<p style="margin-left:.2in"><b>Description</b>:<br> <p style="margin-left:.2in"><b>Description</b>:<br>
This function is called by the slurmctld daemon with job modification parameters This function is called by the slurmctld daemon with job modification parameters
supplied by the scontrol or sview command. It can be used to log and/or supplied by the scontrol or sview command. It can be used to log and/or
...@@ -106,7 +106,7 @@ examine the available partitions, reservations, etc. ...@@ -106,7 +106,7 @@ examine the available partitions, reservations, etc.
<span class="commandline">job_ptr</span> <span class="commandline">job_ptr</span>
(input/output) slurmctld daemon's current data structure for the job to (input/output) slurmctld daemon's current data structure for the job to
be modified.<br> be modified.<br>
<span class="commandline">submit_uid</span> <span class="commandline">modify_uid</span>
(input) user ID initiating the request.<br> (input) user ID initiating the request.<br>
<p style="margin-left:.2in"><b>Returns</b>: <br> <p style="margin-left:.2in"><b>Returns</b>: <br>
<span class="commandline">SLURM_SUCCESS</span> on success, or<br> <span class="commandline">SLURM_SUCCESS</span> on success, or<br>
...@@ -120,7 +120,7 @@ the Lua scripts is the same location as the SLURM configuration file, ...@@ -120,7 +120,7 @@ the Lua scripts is the same location as the SLURM configuration file,
<i>slurm.conf</i>.</p> <i>slurm.conf</i>.</p>
<p class="commandline"> <p class="commandline">
int job_submit(struct job_descriptor *job_desc, List part_list) int job_submit(struct job_descriptor *job_desc, List part_list, uint32_t submit_uid)
<p style="margin-left:.2in"><b>Description</b>:<br> <p style="margin-left:.2in"><b>Description</b>:<br>
This function is called by the slurmctld daemon with job submission parameters This function is called by the slurmctld daemon with job submission parameters
supplied by the salloc, sbatch or srun command. It can be used to log and/or supplied by the salloc, sbatch or srun command. It can be used to log and/or
...@@ -132,6 +132,8 @@ to examine the available partitions, reservations, etc. ...@@ -132,6 +132,8 @@ to examine the available partitions, reservations, etc.
(input/output) the job allocation request specifications.<br> (input/output) the job allocation request specifications.<br>
<span class="commandline">part_list</span> <span class="commandline">part_list</span>
(input) List of pointer to partitions which this user is authorized to use.<br> (input) List of pointer to partitions which this user is authorized to use.<br>
<span class="commandline">submit_uid</span>
(input) user ID initiating the request.<br>
<p style="margin-left:.2in"><b>Returns</b>: <br> <p style="margin-left:.2in"><b>Returns</b>: <br>
<span class="commandline">0</span> on success, or an <span class="commandline">0</span> on success, or an
errno on failure. SLURM specific error numbers from <i>slurm/slurm_errno.h</i> errno on failure. SLURM specific error numbers from <i>slurm/slurm_errno.h</i>
...@@ -140,7 +142,7 @@ appropriate error message printed for that errno. ...@@ -140,7 +142,7 @@ appropriate error message printed for that errno.
<p class="commandline"> <p class="commandline">
int job_modify(struct job_descriptor *job_desc, struct job_record *job_ptr, int job_modify(struct job_descriptor *job_desc, struct job_record *job_ptr,
List part_list) List part_list, int modify_uid)
<p style="margin-left:.2in"><b>Description</b>:<br> <p style="margin-left:.2in"><b>Description</b>:<br>
This function is called by the slurmctld daemon with job modification parameters This function is called by the slurmctld daemon with job modification parameters
supplied by the scontrol or sview command. It can be used to log and/or supplied by the scontrol or sview command. It can be used to log and/or
...@@ -155,6 +157,8 @@ examine the available partitions, reservations, etc. ...@@ -155,6 +157,8 @@ examine the available partitions, reservations, etc.
be modified.<br> be modified.<br>
<span class="commandline">part_list</span> <span class="commandline">part_list</span>
(input) List of pointer to partitions which this user is authorized to use.<br> (input) List of pointer to partitions which this user is authorized to use.<br>
<span class="commandline">modify_uid</span>
(input) user ID initiating the request.<br>
<span class="commandline">0</span> on success, or an <span class="commandline">0</span> on success, or an
errno on failure. SLURM specific error numbers from <i>slurm/slurm_errno.h</i> errno on failure. SLURM specific error numbers from <i>slurm/slurm_errno.h</i>
may be used. On failure, the request will be rejected and the user will have an may be used. On failure, the request will be rejected and the user will have an
...@@ -166,6 +170,6 @@ appropriate error message printed for that errno. ...@@ -166,6 +170,6 @@ appropriate error message printed for that errno.
releases of SLURM may revise this API. releases of SLURM may revise this API.
<p class="footer"><a href="#top">top</a> <p class="footer"><a href="#top">top</a>
<p style="text-align:center;">Last modified 8 May 2014</p> <p style="text-align:center;">Last modified 16 July 2014</p>
<!--#include virtual="footer.txt"--> <!--#include virtual="footer.txt"-->
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