diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index dcd95fbfd5abc14f448c0cc652d9feb320dc5de1..6565ee8a344bb87570c2ae6e08d5ffb6c36b2664 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -9,9 +9,9 @@ man1_MANS = \ man1/squeue.1 \ man1/srun.1 -man3_MANS = man3/hostlist_create.3 \ - man3/hostlist_destroy.3 \ - man3/hostlist_shift.3 \ +man3_MANS = man3/slurm_hostlist_create.3 \ + man3/slurm_hostlist_destroy.3 \ + man3/slurm_hostlist_shift.3 \ man3/slurm_allocate_resources.3 \ man3/slurm_allocate_resources_and_run.3 \ man3/slurm_api_version.3 \ diff --git a/doc/man/man3/hostlist_destroy.3 b/doc/man/man3/hostlist_destroy.3 deleted file mode 100644 index b558a409e434717cb3d8ec33e51e13c725d27eef..0000000000000000000000000000000000000000 --- a/doc/man/man3/hostlist_destroy.3 +++ /dev/null @@ -1 +0,0 @@ -.so man3/hostlist_create.3 diff --git a/doc/man/man3/hostlist_shift.3 b/doc/man/man3/hostlist_shift.3 deleted file mode 100644 index b558a409e434717cb3d8ec33e51e13c725d27eef..0000000000000000000000000000000000000000 --- a/doc/man/man3/hostlist_shift.3 +++ /dev/null @@ -1 +0,0 @@ -.so man3/hostlist_create.3 diff --git a/doc/man/man3/hostlist_create.3 b/doc/man/man3/slurm_hostlist_create.3 similarity index 65% rename from doc/man/man3/hostlist_create.3 rename to doc/man/man3/slurm_hostlist_create.3 index 4fb4c7ccb7487a06926334bf028a80fe439a576c..1d5b5caddbf69f3703c4bf90e91ac715f42e7b9d 100644 --- a/doc/man/man3/hostlist_create.3 +++ b/doc/man/man3/slurm_hostlist_create.3 @@ -1,24 +1,24 @@ -.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" -hostlist_create \- Slurm host list support functions +slurm_hostlist_create \- Slurm host list support functions .SH "SYNTAX" .LP #include <hostlist.h> .LP .LP -hostlist_t \fBhostlist_create\fR ( +hostlist_t \fBslurm_hostlist_create\fR ( .br char *\fInode_list\fP .br ); .LP -char * \fBhostlist_shift\fR ( +char * \fBslurm_hostlist_shift\fR ( .br hostlist_t \fIhost_list\fP .br ); .LP -void \fBhostlist_destroy\fR ( +void \fBslurm_hostlist_destroy\fR ( .br hostlist_t \fIhost_list\fP .br @@ -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"). .TP \fIhost_list\fP -A hostlist created by the \fBhostlist_create\fR function. +A hostlist created by the \fBslurm_hostlist_create\fR function. .SH "DESCRIPTION" .LP -\fBhostlist_create\fR creates a database of node names from a regular expression -describing node names. Use \fBhostlist_destroy\fR to release storage associated +\fBslurm_hostlist_create\fR creates a database of node names from a regular expression +describing node names. Use \fBslurm_hostlist_destroy\fR to release storage associated with the database when no longer required. .LP -\fBhostlist_shift\fR extracts the first entry from the host list database created -by the \fBhostlist_create\fR function. +\fBslurm_hostlist_shift\fR extracts the first entry from the host list database created +by the \fBslurm_hostlist_create\fR function. .LP -\fBhostlist_destroy\fR releases storage associated with a database created by -\fBhostlist_create\fR when no longer required. +\fBslurm_hostlist_destroy\fR releases storage associated with a database created by +\fBslurm_hostlist_create\fR when no longer required. .SH "RETURN VALUE" .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. .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. .SH "EXAMPLE" @@ -77,7 +77,7 @@ int main (int argc, char *argv[]) .br /* slurm job step creation function */ .LP - my_hostlist = hostlist_create (hostnames); + my_hostlist = slurm_hostlist_create (hostnames); .br if (my_hostlist == NULL) { .br @@ -87,11 +87,11 @@ int main (int argc, char *argv[]) .br } .LP - while ( (host = hostlist_shift(my_hostlist)) ) + while ( (host = slurm_hostlist_shift(my_hostlist)) ) .br printf ("host = %s\\n", host); .LP - hostlist_destroy (my_hostlist) ; + slurm_hostlist_destroy (my_hostlist) ; .br exit (0); .br diff --git a/doc/man/man3/slurm_hostlist_destroy.3 b/doc/man/man3/slurm_hostlist_destroy.3 new file mode 100644 index 0000000000000000000000000000000000000000..7772e639623991b170f36c2eb0a0ee77d9a53c6d --- /dev/null +++ b/doc/man/man3/slurm_hostlist_destroy.3 @@ -0,0 +1 @@ +.so man3/slurm_hostlist_create.3 diff --git a/doc/man/man3/slurm_hostlist_shift.3 b/doc/man/man3/slurm_hostlist_shift.3 new file mode 100644 index 0000000000000000000000000000000000000000..7772e639623991b170f36c2eb0a0ee77d9a53c6d --- /dev/null +++ b/doc/man/man3/slurm_hostlist_shift.3 @@ -0,0 +1 @@ +.so man3/slurm_hostlist_create.3