Ticket 8270

Summary:	minor error in salloc / sbatch / srun man page - SLURM_TASKS_PER_NODE description
Product:	Slurm	Reporter:	Deric Sullivan <deric.sullivan>
Component:	Documentation	Assignee:	Tim Wickberg <tim>
Status:	RESOLVED FIXED	QA Contact:
Severity:	C - Contributions
Priority:	---
Version:	19.05.5
Hardware:	Linux
OS:	Linux
Site:	SSC/SPC	Alineos Sites:	---
Atos/Eviden Sites:	---	Confidential Site:	---
Coreweave sites:	---	Cray Sites:	---
DS9 clusters:	---	HPCnow Sites:	---
HPE Sites:	---	IBM Sites:	---
NOAA SIte:	---	OCF Sites:	---
Recursion Pharma Sites:	---	SFW Sites:	---
SNIC sites:	---	Linux Distro:	---
Machine Name:		CLE Version:
Version Fixed:	19.05.6 20.02.0pre1	Target Release:	---
DevPrio:	---	Emory-Cloud Sites:	---

Description Deric Sullivan 2019-12-23 12:44:22 MST

Hello,
I think there is a small error in the salloc / sbatch / srun man pages.  The description of SLURM_TASKS_PER_NODE looks incorrect for the example given.  In case it's of any use, included is a patch.

$ diff -Naur doc/man/man1/salloc.1 doc/man/man1/salloc.1.new 
--- doc/man/man1/salloc.1	2019-12-23 18:55:49.829500000 +0000
+++ doc/man/man1/salloc.1.new	2019-12-23 19:18:14.159373000 +0000
@@ -1942,7 +1942,7 @@
 If two or more consecutive nodes are to have the same task
 count, that count is followed by "(x#)" where "#" is the
 repetition count. For example, "SLURM_TASKS_PER_NODE=2(x3),1"
-indicates that the first three nodes will each execute three
+indicates that the first three nodes will each execute two
 tasks and the fourth node will execute one task.
 
 .SH "SIGNALS"
$ 
$ diff -Naur doc/man/man1/sbatch.1 doc/man/man1/sbatch.1.new 
--- doc/man/man1/sbatch.1	2019-12-23 18:55:49.833493000 +0000
+++ doc/man/man1/sbatch.1.new	2019-12-23 19:20:04.786061000 +0000
@@ -2241,7 +2241,7 @@
 If two or more consecutive nodes are to have the same task
 count, that count is followed by "(x#)" where "#" is the
 repetition count. For example, "SLURM_TASKS_PER_NODE=2(x3),1"
-indicates that the first three nodes will each execute three
+indicates that the first three nodes will each execute two
 tasks and the fourth node will execute one task.
 .TP
 \fBSLURM_TASK_PID\fR
$ 
$ diff -Naur doc/man/man1/srun.1 doc/man/man1/srun.1.new 
--- doc/man/man1/srun.1	2019-12-23 18:55:49.858489000 +0000
+++ doc/man/man1/srun.1.new	2019-12-23 19:19:20.867658000 +0000
@@ -2998,7 +2998,7 @@
 If two or more consecutive nodes are to have the same task
 count, that count is followed by "(x#)" where "#" is the
 repetition count. For example, "SLURM_TASKS_PER_NODE=2(x3),1"
-indicates that the first three nodes will each execute three
+indicates that the first three nodes will each execute two
 tasks and the fourth node will execute one task.
 
 .TP
$ 


Thanks,
Deric

Comment 1 Tim Wickberg 2019-12-23 12:52:20 MST

Thanks Deric, you're correct in that the example was flawed.

I've pushed your patch to the slurm-19.05 branch, and it will be included in 19.05.6 when released.

Thanks!

- Tim

commit e4ca77520292ac58c611859bd2ace2ed193f3447
Author:     Deric Sullivan <deric.sullivan@canada.ca>
AuthorDate: Mon Dec 23 12:49:58 2019 -0700

    Docs - fix mistake in examples for SLURM_TASKS_PER_NODE env var.
    
    Bug 8270.