From 8fa12a68ab8a32309daac29af87660139724c598 Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Mon, 15 Sep 2003 23:45:04 +0000 Subject: [PATCH] Add SLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT to almost all API man pages. --- doc/man/man3/slurm_allocate_resources.3 | 5 ++++- doc/man/man3/slurm_complete_job.3 | 5 ++++- doc/man/man3/slurm_free_ctl_conf.3 | 5 ++++- doc/man/man3/slurm_free_job_info_msg.3 | 5 ++++- .../slurm_free_job_step_info_response_msg.3 | 5 ++++- doc/man/man3/slurm_free_node_info.3 | 8 ++++++-- doc/man/man3/slurm_free_partition_info.3 | 8 ++++++-- doc/man/man3/slurm_job_step_create.3 | 5 ++++- doc/man/man3/slurm_kill_job.3 | 5 ++++- doc/man/man3/slurm_reconfigure.3 | 18 ++++++++++++------ 10 files changed, 52 insertions(+), 17 deletions(-) diff --git a/doc/man/man3/slurm_allocate_resources.3 b/doc/man/man3/slurm_allocate_resources.3 index 889265ef483..e875ae4831d 100644 --- a/doc/man/man3/slurm_allocate_resources.3 +++ b/doc/man/man3/slurm_allocate_resources.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "August 2003" "Morris Jette" "Slurm job initiation functions" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job initiation functions" .SH "NAME" slurm_allocate_resources, slurm_allocate_resources_and_run, slurm_confirm_allocation, @@ -211,6 +211,9 @@ the partition's time limit. \fBESLURM_INTERCONNECT_FAILURE\fR failed to configure the node interconnect. .LP \fBESLURM_BAD_DIST\fR task distribution specification is invalid. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_complete_job.3 b/doc/man/man3/slurm_complete_job.3 index e5abdb6c76b..9d4f2e56b59 100644 --- a/doc/man/man3/slurm_complete_job.3 +++ b/doc/man/man3/slurm_complete_job.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm job completion calls" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job completion calls" .SH "NAME" slurm_complete_job, slurm_complete_job_step \- Slurm job completion calls .SH "SYNTAX" @@ -63,6 +63,9 @@ not be modified. \fBESLURM_ACCESS_DENIED\fR the requesting user lacks authorization for the requested action (e.g. trying to delete or modify another user's job). .LP \fBESLURM_INTERCONNECT_FAILURE\fR failed to configure the node interconnect. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "COPYING" Copyright (C) 2002 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). diff --git a/doc/man/man3/slurm_free_ctl_conf.3 b/doc/man/man3/slurm_free_ctl_conf.3 index f326d4450b9..cddf4aad87a 100644 --- a/doc/man/man3/slurm_free_ctl_conf.3 +++ b/doc/man/man3/slurm_free_ctl_conf.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm informational calls" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm informational calls" .SH "NAME" slurm_free_ctl_conf, slurm_load_ctl_conf, slurm_print_ctl_conf\- Slurm information reporting functions @@ -68,6 +68,9 @@ is set appropriately. \fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR. .LP \fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_free_job_info_msg.3 b/doc/man/man3/slurm_free_job_info_msg.3 index 61ee2fcfe18..b3fad502213 100644 --- a/doc/man/man3/slurm_free_job_info_msg.3 +++ b/doc/man/man3/slurm_free_job_info_msg.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm job information reporting functions" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job information reporting functions" .SH "NAME" slurm_free_job_info_msg, slurm_load_jobs, slurm_print_job_info, slurm_print_job_info_msg @@ -110,6 +110,9 @@ On success, zero is returned. On error, -1 is returned, and Slurm error code is \fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code. .LP \fBESLURM_INVALID_JOB_ID\fR Request for information about a non-existent job. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_free_job_step_info_response_msg.3 b/doc/man/man3/slurm_free_job_step_info_response_msg.3 index 7a261633f08..8a62c769642 100644 --- a/doc/man/man3/slurm_free_job_step_info_response_msg.3 +++ b/doc/man/man3/slurm_free_job_step_info_response_msg.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm job step information functions" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job step information functions" .SH "NAME" \fBslurm_free_job_step_info_response_msg, slurm_get_job_steps, slurm_print_job_step_info, slurm_print_job_step_info_msg @@ -103,6 +103,9 @@ code is set appropriately. \fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR. .LP \fBSLURM_PROTOCOL_VERSION_ERROR\fR Protocol version has changed, re-link your code. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_free_node_info.3 b/doc/man/man3/slurm_free_node_info.3 index 68225f35178..7ae00356561 100644 --- a/doc/man/man3/slurm_free_node_info.3 +++ b/doc/man/man3/slurm_free_node_info.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm node informational calls" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm node informational calls" .SH "NAME" slurm_free_node_info, slurm_load_node, slurm_print_node_info_msg, slurm_print_node_table @@ -95,7 +95,11 @@ is set appropriately. .LP \fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR. .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. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_free_partition_info.3 b/doc/man/man3/slurm_free_partition_info.3 index 8b77276407b..b7f33e9a050 100644 --- a/doc/man/man3/slurm_free_partition_info.3 +++ b/doc/man/man3/slurm_free_partition_info.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm partition information reporting functions" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm partition information reporting functions" .SH "NAME" slurm_free_partition_info, slurm_load_partitions, slurm_print_partition_info, slurm_print_partition_info_msg @@ -78,7 +78,11 @@ On success, zero is returned. On error, -1 is returned, and Slurm error code is .LP \fBSLURM_NO_CHANGE_IN_DATA\fR Data has not changed since \fBupdate_time\fR. .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. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> diff --git a/doc/man/man3/slurm_job_step_create.3 b/doc/man/man3/slurm_job_step_create.3 index 35c8583331e..d5bc464c2f6 100644 --- a/doc/man/man3/slurm_job_step_create.3 +++ b/doc/man/man3/slurm_job_step_create.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm job step initiation functions" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job step initiation functions" .SH "NAME" slurm_job_step_create \- Slurm job step initiation functions .SH "SYNTAX" @@ -57,6 +57,9 @@ On success, zero is returned. On error, -1 is returned, and Slurm error code is \fBESLURM_INTERCONNECT_FAILURE\fR failed to configure the node interconnect. .LP \fBESLURM_BAD_DIST\fR task distribution specification is invalid. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "COPYING" Copyright (C) 2002 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). diff --git a/doc/man/man3/slurm_kill_job.3 b/doc/man/man3/slurm_kill_job.3 index 23c671684f6..b86c628777e 100644 --- a/doc/man/man3/slurm_kill_job.3 +++ b/doc/man/man3/slurm_kill_job.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "July 2003" "Morris Jette" "Slurm job signal calls" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm job signal calls" .SH "NAME" slurm_kill_job, slurm_kill_job_step \- Slurm job signal calls .SH "SYNTAX" @@ -55,6 +55,9 @@ On success, zero is returned. On error, -1 is returned, and Slurm error code is \fBESLURM_ACCESS_DENIED\fR the requesting user lacks authorization for the requested action (e.g. trying to delete or modify another user's job). .LP \fBESLURM_INTERCONNECT_FAILURE\fR failed to configure the node interconnect. +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "COPYING" Copyright (C) 2002 The Regents of the University of California. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). diff --git a/doc/man/man3/slurm_reconfigure.3 b/doc/man/man3/slurm_reconfigure.3 index 44b616a9db2..a9411fcc9dd 100644 --- a/doc/man/man3/slurm_reconfigure.3 +++ b/doc/man/man3/slurm_reconfigure.3 @@ -1,4 +1,4 @@ -.TH "Slurm API" "3" "August 2003" "Morris Jette" "Slurm administrative calls" +.TH "Slurm API" "3" "September 2003" "Morris Jette" "Slurm administrative calls" .SH "NAME" slurm_init_part_desc_msg, slurm_reconfigure, slurm_shutdown, slurm_update_job, @@ -87,19 +87,25 @@ name specified by this function does not already exist, a new partition is creat with the supplied parameters. This function may only be successfully executed by user root. .SH "RETURN VALUE" .LP -On success, zero is returned. On error, -1 is returned, and the Slurm error code is set appropriately. +On success, zero is returned. On error, -1 is returned, and the Slurm error +code is set appropriately. .SH "ERRORS" .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. .LP \fBESLURM_INVALID_NODE_NAME\fR the requested node name(s) is/are not valid. .LP -\fBESLURM_INVALID_NODE_STATE\fR the specified state node state or requested node -state transition is not valid. +\fBESLURM_INVALID_NODE_STATE\fR the specified state node state or requested +node state transition is not valid. .LP \fBESLURM_INVALID_PARTITION_NAME\fR the requested partition name is not valid. .LP -\fBESLURM_ACCESS_DENIED\fR the requesting user lacks authorization for the requested action (e.g. trying to delete or modify another user's job). +\fBESLURM_ACCESS_DENIED\fR the requesting user lacks authorization for +the requested action (e.g. trying to delete or modify another user's job). +.LP +\fBSLURM_PROTOCOL_SOCKET_IMPL_TIMEOUT\fR Timeout in communicating with +SLURM controller. .SH "EXAMPLE" .LP #include <stdio.h> -- GitLab