docs/115721: misleading manual

[Stefan Lambrev]

>Number:         115721
>Category:       docs
>Synopsis:       misleading manual
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 22 14:40:01 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Stefan Lambrev
>Release:        FreeBSD 7-current
>Organization:
>Environment:
FreeBSD hater.cmotd.com 7.0-CURRENT FreeBSD 7.0-CURRENT #0: Tue Jul 10 21:01:38 EEST 2007     root at hater.cmotd.com:/usr/obj/usr/src/sys/CORE64-SMP  amd64

>Description:
>From MDCONFIG(8)

             swap     Swap space is used to back this memory disk.

>From MD(4)

     swap     Backing store is allocated from buffer memory.  Pages get pushed
              out to the swap when the system is under memory pressure, other-
              wise they stay in the operating memory.  Using swap backing is
              generally preferable over malloc backing.

So I suggest to change the text in mdconfig to:

              Storage for this type of memory disk is allocated from buffer
              memory.  Pages get pushed out to the swap when the system is
              under memory pressure, otherwise they stay in the operating
              memory.  Using swap backing is generally preferable over malloc
              backing.
>How-To-Repeat:
man mdconfig
man md
>Fix:


Patch attached with submission follows:

--- src/sbin/mdconfig/mdconfig.8.orig	2007-08-22 17:26:02.000000000 +0300
+++ src/sbin/mdconfig/mdconfig.8	2007-08-22 17:31:44.000000000 +0300
@@ -98,7 +98,14 @@
 .Fl f Ar file
 becomes the backingstore for this memory disk.
 .It Cm swap
-Swap space is used to back this memory disk.
+Storage for this type of memory disk is allocated from buffer
+memory. Pages get pushed out to the swap when the system is
+under memory pressure, otherwise they stay in the operating
+memory. Using 
+.Cm swap
+backing is generally preferable over 
+.Cm malloc
+backing.
 .El
 .It Fl f Ar file
 Filename to use for the vnode type memory disk. Options


>Release-Note:
>Audit-Trail:
>Unformatted: