From c0d6edc9f34fbe4c8399ed6f74ee6f263cf40f14 Mon Sep 17 00:00:00 2001
From: Morris Jette <jette@schedmd.com>
Date: Mon, 11 May 2015 10:50:55 -0700
Subject: [PATCH] Explain job option of --mem=0 means all memory

This is a special case. This change documents the way Slurm has
always worked.
---
 doc/man/man1/salloc.1 | 2 ++
 doc/man/man1/sbatch.1 | 2 ++
 doc/man/man1/srun.1   | 2 ++
 3 files changed, 6 insertions(+)

diff --git a/doc/man/man1/salloc.1 b/doc/man/man1/salloc.1
index 93a0e965264..c941ae0a8d3 100644
--- a/doc/man/man1/salloc.1
+++ b/doc/man/man1/salloc.1
@@ -568,6 +568,8 @@ This parameter would generally be used if whole nodes
 are allocated to jobs (\fBSelectType=select/linear\fR).
 Also see \fB\-\-mem\-per\-cpu\fR.
 \fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive.
+NOTE: A memory size specification is treated as a special case and grants
+the job access to all of the memory on each node.
 NOTE: Enforcement of memory limits currently relies upon the task/cgroup plugin
 or enabling of accounting, which samples memory use on a periodic basis (data
 need not be stored, just collected). In both cases memory use is based upon
diff --git a/doc/man/man1/sbatch.1 b/doc/man/man1/sbatch.1
index 28b03821962..1954f6a66d2 100644
--- a/doc/man/man1/sbatch.1
+++ b/doc/man/man1/sbatch.1
@@ -660,6 +660,8 @@ This parameter would generally be used if whole nodes
 are allocated to jobs (\fBSelectType=select/linear\fR).
 Also see \fB\-\-mem\-per\-cpu\fR.
 \fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive.
+NOTE: A memory size specification is treated as a special case and grants
+the job access to all of the memory on each node.
 NOTE: Enforcement of memory limits currently relies upon the task/cgroup plugin
 or enabling of accounting, which samples memory use on a periodic basis (data
 need not be stored, just collected). In both cases memory use is based upon
diff --git a/doc/man/man1/srun.1 b/doc/man/man1/srun.1
index 27d4c09db9c..21e77d982e8 100644
--- a/doc/man/man1/srun.1
+++ b/doc/man/man1/srun.1
@@ -865,6 +865,8 @@ to the amount of memory allocated to the job, but not remove any of the job's
 memory allocation from being available to other job steps.
 Also see \fB\-\-mem\-per\-cpu\fR.
 \fB\-\-mem\fR and \fB\-\-mem\-per\-cpu\fR are mutually exclusive.
+NOTE: A memory size specification is treated as a special case and grants
+the job access to all of the memory on each node.
 NOTE: Enforcement of memory limits currently relies upon the task/cgroup plugin
 or enabling of accounting, which samples memory use on a periodic basis (data
 need not be stored, just collected). In both cases memory use is based upon
-- 
GitLab