From eabe2afc67b99a3e58f39c5dd7a0c0a672f3a2d1 Mon Sep 17 00:00:00 2001 From: Moe Jette <jette1@llnl.gov> Date: Thu, 17 Feb 2011 23:30:26 +0000 Subject: [PATCH] take-two from Bull on task distribution description in srun, salloc, and sbatch man pages --- doc/man/man1/salloc.1 | 11 ++++------- doc/man/man1/sbatch.1 | 11 ++++------- doc/man/man1/srun.1 | 11 ++++------- doc/man/man5/slurm.conf.5 | 2 ++ 4 files changed, 14 insertions(+), 21 deletions(-) diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1 index 52e1622acb8..d5ac884d1d0 100644 --- a/doc/man/man1/salloc.1 +++ b/doc/man/man1/salloc.1 @@ -465,8 +465,7 @@ Multiple license names should be comma separated (e.g. Specify alternate distribution methods for remote processes. In salloc, this only sets environment variables that will be used by subsequent srun requests. -This option does not affect the allocation of resources to -a job or step, but only the assignment of tasks to the nodes on which +This option controls the assignment of tasks to the nodes on which resources have been allocated, and the distribution of those resources to tasks for binding (task affinity). The first distribution method (before the ":") controls the distribution of resources across @@ -497,11 +496,9 @@ nodes each with two cpus. A four\-task cyclic distribution request will distribute those tasks to the nodes with tasks one and four on the first node, task two on the second node, and task three on the third node. -Note that when SelectType is select/cons_res the same number of CPUs -may not be allocated on each node. -Distribution will be round\-robin among all the nodes with CPUs yet to -be assigned tasks. If you want the same number of CPUs allocated on -all nodes, use the \-\-ntasks\-per\-node option. +Note that when SelectType is select/cons_res, the same number of CPUs +may not be allocated on each node. Task distribution will be +round\-robin among all the nodes with CPUs yet to be assigned to tasks. Cyclic distribution is the default behavior if the number of tasks is no larger than the number of allocated nodes. .TP diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1 index 94d9f085ca6..c653b27cbe6 100644 --- a/doc/man/man1/sbatch.1 +++ b/doc/man/man1/sbatch.1 @@ -519,8 +519,7 @@ between clusters. Specify alternate distribution methods for remote processes. In sbatch, this only sets environment variables that will be used by subsequent srun requests. -This option does not affect the allocation of resources to -a job or step, but only the assignment of tasks to the nodes on which +This option controls the assignment of tasks to the nodes on which resources have been allocated, and the distribution of those resources to tasks for binding (task affinity). The first distribution method (before the ":") controls the distribution of resources across @@ -551,11 +550,9 @@ nodes each with two cpus. A four\-task cyclic distribution request will distribute those tasks to the nodes with tasks one and four on the first node, task two on the second node, and task three on the third node. -Note that when SelectType is select/cons_res the same number of CPUs -may not be allocated on each node. -Distribution will be round\-robin among all the nodes with CPUs yet to -be assigned tasks. If you want the same number of CPUs allocated on -all nodes, use the \-\-ntasks\-per\-node option. +Note that when SelectType is select/cons_res, the same number of CPUs +may not be allocated on each node. Task distribution will be +round\-robin among all the nodes with CPUs yet to be assigned to tasks. Cyclic distribution is the default behavior if the number of tasks is no larger than the number of allocated nodes. .TP diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1 index b7ba4cba2a2..3d88fa31927 100644 --- a/doc/man/man1/srun.1 +++ b/doc/man/man1/srun.1 @@ -516,8 +516,7 @@ Multiple license names should be comma separated (e.g. <\fIblock\fR|\fIcyclic\fR|\fIarbitrary\fR|\fIplane=<options>\fR[:\fIblock\fR|\fIcyclic\fR]> Specify alternate distribution methods for remote processes. -This option does not affect the allocation of resources to -a job or step, but only the assignment of tasks to the nodes on which +This option controls the assignment of tasks to the nodes on which resources have been allocated, and the distribution of those resources to tasks for binding (task affinity). The first distribution method (before the ":") controls the distribution of resources across @@ -548,11 +547,9 @@ nodes each with two cpus. A four\-task cyclic distribution request will distribute those tasks to the nodes with tasks one and four on the first node, task two on the second node, and task three on the third node. -Note that when SelectType is select/cons_res the same number of CPUs -may not be allocated on each node. -Distribution will be round\-robin among all the nodes with CPUs yet to -be assigned tasks. If you want the same number of CPUs allocated on -all nodes, use the \-\-ntasks\-per\-node option. +Note that when SelectType is select/cons_res, the same number of CPUs +may not be allocated on each node. Task distribution will be +round\-robin among all the nodes with CPUs yet to be assigned to tasks. Cyclic distribution is the default behavior if the number of tasks is no larger than the number of allocated nodes. .TP diff --git a/doc/man/man5/slurm.conf.5 b/doc/man/man5/slurm.conf.5 index 339a80e7753..6f913f9ae97 100644 --- a/doc/man/man5/slurm.conf.5 +++ b/doc/man/man5/slurm.conf.5 @@ -1486,6 +1486,8 @@ thread on nodes with more than one \fBThreadsPerCore\fR configured. .TP \fBCR_CORE_DEFAULT_DIST_BLOCK\fR Allocate cores using block distribution by default. +This default behavior can be overridden specifying a particular +"\-m" parameter with srun/salloc/sbatch. Without this option, cores will be allocated cyclicly across the sockets. .TP \fBCR_Socket\fR -- GitLab