From 6953d7db5c87f77253f15cd382b7b749074e23cf Mon Sep 17 00:00:00 2001
From: Benjamin Kaduk <bjk@FreeBSD.org>
Date: Sat, 17 May 2014 03:05:52 +0000
Subject: [PATCH] Correct documentation of the limit on how much memory can be
 mlock()ed

vm.max_wired is a system-wide limit, not per-process.  Reword the
section to make this more clear.

PR:		docs/189214
Submitted by:	Lawrence Chen (original text)
Approved by:	hrs (mentor)
---
 lib/libc/sys/mlock.2 | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/lib/libc/sys/mlock.2 b/lib/libc/sys/mlock.2
index 42acc971661f..5c914f430e81 100644
--- a/lib/libc/sys/mlock.2
+++ b/lib/libc/sys/mlock.2
@@ -28,7 +28,7 @@
 .\"	@(#)mlock.2	8.2 (Berkeley) 12/11/93
 .\" $FreeBSD$
 .\"
-.Dd March 18, 2013
+.Dd May 17, 2014
 .Dt MLOCK 2
 .Os
 .Sh NAME
@@ -91,14 +91,21 @@ Locked mappings are not inherited by the child process after a
 .Pp
 Since physical memory is a potentially scarce resource, processes are
 limited in how much they can lock down.
-A single process can
+The amount of memory that a single process can
 .Fn mlock
-the minimum of
-a system-wide ``wired pages'' limit
-.Va vm.max_wired
-and the per-process
+is limited by both the per-process
 .Li RLIMIT_MEMLOCK
-resource limit.
+resource limit and the
+system-wide
+.Dq wired pages
+limit
+.Va vm.max_wired .
+.Va vm.max_wired
+applies to the system as a whole, so the amount available to a single
+process at any given time is the difference between
+.Va vm.max_wired
+and
+.Va vm.stats.vm.v_wire_count .
 .Pp
 If
 .Va security.bsd.unprivileged_mlock