From asmodai@nexus.ninth-circle.org  Sat Dec 14 02:37:49 2002
Return-Path: <asmodai@nexus.ninth-circle.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id EC69737B401
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 14 Dec 2002 02:37:49 -0800 (PST)
Received: from 213-84-207-11.adsl.xs4all.nl (nexus.xs4all.nl [213.84.207.11])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 52C2443ED1
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 14 Dec 2002 02:37:49 -0800 (PST)
	(envelope-from asmodai@nexus.ninth-circle.org)
Received: by 213-84-207-11.adsl.xs4all.nl (Postfix, from userid 1000)
	id 7EA7C19D; Sat, 14 Dec 2002 11:39:06 +0100 (CET)
Message-Id: <20021214103906.7EA7C19D@213-84-207-11.adsl.xs4all.nl>
Date: Sat, 14 Dec 2002 11:39:06 +0100 (CET)
From: Jeroen Ruigrok van der Werven <asmodai@wxs.nl>
Reply-To: Jeroen Ruigrok van der Werven <asmodai@wxs.nl>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: madvise(2) manual page is too specific
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         46253
>Category:       docs
>Synopsis:       madvise(2) manual page is too specific
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Dec 14 02:40:02 PST 2002
>Closed-Date:    Mon Jan 06 15:35:07 PST 2003
>Last-Modified:  Mon Jan 06 15:35:07 PST 2003
>Originator:     Jeroen Ruigrok van der Werven
>Release:        FreeBSD 4.7-STABLE i386
>Organization:
Ninth Circle Enterprises
>Environment:
System: FreeBSD nexus.chronias.ninth-circle.org 4.7-STABLE FreeBSD 4.7-STABLE #5: Sat Oct 19 12:35:12 CEST 2002 asmodai@nexus.chronias.ninth-circle.org:/usr/src/sys/compile/NEXUS i386

>Description:

The madvise(2) manual page is too specific and redundant.
It shows an excerpt of the mman.h header file complete with definitions
of the symbolic names to the values.
Just mentioning the names, which happens later on in the manual page, should
be enough, and not cause people to hardwire any values.

>How-To-Repeat:

Read the manual page.

>Fix:

Apply attached patch:

Index: src/lib/libc/sys/madvise.2
===================================================================
RCS file: /home/ncvs/FreeBSD/src/lib/libc/sys/madvise.2,v
retrieving revision 1.24
diff -u -r1.24 madvise.2
--- src/lib/libc/sys/madvise.2	24 Aug 2002 00:39:43 -0000	1.24
+++ src/lib/libc/sys/madvise.2	14 Dec 2002 10:31:43 -0000
@@ -50,21 +50,8 @@
 system call
 allows a process that has knowledge of its memory behavior
 to describe it to the system.
-The known behaviors are given in
-.Aq Pa sys/mman.h :
-.Bd -literal
-#define	MADV_NORMAL	0 /* no further special treatment */
-#define	MADV_RANDOM	1 /* expect random page references */
-#define	MADV_SEQUENTIAL	2 /* expect sequential references */
-#define	MADV_WILLNEED	3 /* will need these pages */
-#define	MADV_DONTNEED	4 /* don't need these pages */
-#define	MADV_FREE	5 /* data is now unimportant */
-#define MADV_NOSYNC	6 /* no explicit commit to physical backing store */
-#define MADV_AUTOSYNC	7 /* default commit method to physical backing store */
-#define MADV_NOCORE	8 /* do not include these pages in a core file */
-#define MADV_CORE	9 /* revert to including pages in a core file */
-.Ed
 .Pp
+The known behaviours are:
 .Bl -tag -width MADV_SEQUENTIAL
 .It Dv MADV_NORMAL
 Tells the system to revert to the default paging
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Mon Jan 6 15:34:33 PST 2003 
State-Changed-Why:  
Committed!  Thanks for the submission! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=46253 
>Unformatted:
