From owner-svn-src-head@FreeBSD.ORG  Sat May 17 03:05:53 2014
Return-Path: <owner-svn-src-head@FreeBSD.ORG>
Delivered-To: svn-src-head@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id 6CF7FE5A;
 Sat, 17 May 2014 03:05:53 +0000 (UTC)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 5ADFA24ED;
 Sat, 17 May 2014 03:05:53 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s4H35rI1031293;
 Sat, 17 May 2014 03:05:53 GMT (envelope-from bjk@svn.freebsd.org)
Received: (from bjk@localhost)
 by svn.freebsd.org (8.14.8/8.14.8/Submit) id s4H35r9J031292;
 Sat, 17 May 2014 03:05:53 GMT (envelope-from bjk@svn.freebsd.org)
Message-Id: <201405170305.s4H35r9J031292@svn.freebsd.org>
From: Benjamin Kaduk <bjk@FreeBSD.org>
Date: Sat, 17 May 2014 03:05:53 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r266285 - head/lib/libc/sys
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-head@freebsd.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: SVN commit messages for the src tree for head/-current
 <svn-src-head.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-head/>
List-Post: <mailto:svn-src-head@freebsd.org>
List-Help: <mailto:svn-src-head-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 17 May 2014 03:05:53 -0000

Author: bjk (doc committer)
Date: Sat May 17 03:05:52 2014
New Revision: 266285
URL: http://svnweb.freebsd.org/changeset/base/266285

Log:
  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)

Modified:
  head/lib/libc/sys/mlock.2

Modified: head/lib/libc/sys/mlock.2
==============================================================================
--- head/lib/libc/sys/mlock.2	Sat May 17 03:03:17 2014	(r266284)
+++ head/lib/libc/sys/mlock.2	Sat May 17 03:05:52 2014	(r266285)
@@ -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
 .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