Date: Sat, 14 Dec 2002 11:39:06 +0100 (CET) From: Jeroen Ruigrok van der Werven <asmodai@wxs.nl> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/46253: madvise(2) manual page is too specific Message-ID: <20021214103906.7EA7C19D@213-84-207-11.adsl.xs4all.nl>
next in thread | raw e-mail | index | archive | help
>Number: 46253 >Category: docs >Synopsis: madvise(2) manual page is too specific >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Sat Dec 14 02:40:02 PST 2002 >Closed-Date: >Last-Modified: >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: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20021214103906.7EA7C19D>