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

Rename man pages for hostlist_ functions to have "slurm_" prefix.

parent 8f91454f
No related branches found
No related tags found
No related merge requests found
...@@ -9,9 +9,9 @@ man1_MANS = \ ...@@ -9,9 +9,9 @@ man1_MANS = \
man1/squeue.1 \ man1/squeue.1 \
man1/srun.1 man1/srun.1
man3_MANS = man3/hostlist_create.3 \ man3_MANS = man3/slurm_hostlist_create.3 \
man3/hostlist_destroy.3 \ man3/slurm_hostlist_destroy.3 \
man3/hostlist_shift.3 \ man3/slurm_hostlist_shift.3 \
man3/slurm_allocate_resources.3 \ man3/slurm_allocate_resources.3 \
man3/slurm_allocate_resources_and_run.3 \ man3/slurm_allocate_resources_and_run.3 \
man3/slurm_api_version.3 \ man3/slurm_api_version.3 \
......
.so man3/hostlist_create.3
.so man3/hostlist_create.3
.TH "Slurm API" "3" "January 2003" "Morris Jette" "Slurm host list support functions" .TH "Slurm API" "3" "May 2004" "Morris Jette" "Slurm host list support functions"
.SH "NAME" .SH "NAME"
hostlist_create \- Slurm host list support functions slurm_hostlist_create \- Slurm host list support functions
.SH "SYNTAX" .SH "SYNTAX"
.LP .LP
#include <hostlist.h> #include <hostlist.h>
.LP .LP
.LP .LP
hostlist_t \fBhostlist_create\fR ( hostlist_t \fBslurm_hostlist_create\fR (
.br .br
char *\fInode_list\fP char *\fInode_list\fP
.br .br
); );
.LP .LP
char * \fBhostlist_shift\fR ( char * \fBslurm_hostlist_shift\fR (
.br .br
hostlist_t \fIhost_list\fP hostlist_t \fIhost_list\fP
.br .br
); );
.LP .LP
void \fBhostlist_destroy\fR ( void \fBslurm_hostlist_destroy\fR (
.br .br
hostlist_t \fIhost_list\fP hostlist_t \fIhost_list\fP
.br .br
...@@ -34,27 +34,27 @@ regular expression to describe numeric ranges of values and/or multiple numeric ...@@ -34,27 +34,27 @@ regular expression to describe numeric ranges of values and/or multiple numeric
values (e.g. "linux[1-3,6]" represents "linux1", "linux2", "linux3", and "linux6"). values (e.g. "linux[1-3,6]" represents "linux1", "linux2", "linux3", and "linux6").
.TP .TP
\fIhost_list\fP \fIhost_list\fP
A hostlist created by the \fBhostlist_create\fR function. A hostlist created by the \fBslurm_hostlist_create\fR function.
.SH "DESCRIPTION" .SH "DESCRIPTION"
.LP .LP
\fBhostlist_create\fR creates a database of node names from a regular expression \fBslurm_hostlist_create\fR creates a database of node names from a regular expression
describing node names. Use \fBhostlist_destroy\fR to release storage associated describing node names. Use \fBslurm_hostlist_destroy\fR to release storage associated
with the database when no longer required. with the database when no longer required.
.LP .LP
\fBhostlist_shift\fR extracts the first entry from the host list database created \fBslurm_hostlist_shift\fR extracts the first entry from the host list database created
by the \fBhostlist_create\fR function. by the \fBslurm_hostlist_create\fR function.
.LP .LP
\fBhostlist_destroy\fR releases storage associated with a database created by \fBslurm_hostlist_destroy\fR releases storage associated with a database created by
\fBhostlist_create\fR when no longer required. \fBslurm_hostlist_create\fR when no longer required.
.SH "RETURN VALUE" .SH "RETURN VALUE"
.LP .LP
\fBhostlist_create\fR returns the host list database or NULL if memory can not be \fBslurm_hostlist_create\fR returns the host list database or NULL if memory can not be
allocated for the database. allocated for the database.
.LP .LP
\fBhostlist_shift\fR returns a character string or NULL if no entries remain in \fBslurm_hostlist_shift\fR returns a character string or NULL if no entries remain in
the database. the database.
.SH "EXAMPLE" .SH "EXAMPLE"
...@@ -77,7 +77,7 @@ int main (int argc, char *argv[]) ...@@ -77,7 +77,7 @@ int main (int argc, char *argv[])
.br .br
/* slurm job step creation function */ /* slurm job step creation function */
.LP .LP
my_hostlist = hostlist_create (hostnames); my_hostlist = slurm_hostlist_create (hostnames);
.br .br
if (my_hostlist == NULL) { if (my_hostlist == NULL) {
.br .br
...@@ -87,11 +87,11 @@ int main (int argc, char *argv[]) ...@@ -87,11 +87,11 @@ int main (int argc, char *argv[])
.br .br
} }
.LP .LP
while ( (host = hostlist_shift(my_hostlist)) ) while ( (host = slurm_hostlist_shift(my_hostlist)) )
.br .br
printf ("host = %s\\n", host); printf ("host = %s\\n", host);
.LP .LP
hostlist_destroy (my_hostlist) ; slurm_hostlist_destroy (my_hostlist) ;
.br .br
exit (0); exit (0);
.br .br
......
.so man3/slurm_hostlist_create.3
.so man3/slurm_hostlist_create.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