Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src/lib/libc/sys mincore(2): Clarify units of len argument: byte...



details:   https://anonhg.NetBSD.org/src/rev/93d297154d13
branches:  trunk
changeset: 368668:93d297154d13
user:      riastradh <riastradh%NetBSD.org@localhost>
date:      Mon Jul 25 22:50:42 2022 +0000

description:
mincore(2): Clarify units of len argument: bytes, not pages.

Minor tidying while here:

- Use .Fa, not .Ar, for function arguments.
- Reduce verbiage of opening sentence.

diffstat:

 lib/libc/sys/mincore.2 |  20 +++++++++++---------
 1 files changed, 11 insertions(+), 9 deletions(-)

diffs (48 lines):

diff -r fa29755715fe -r 93d297154d13 lib/libc/sys/mincore.2
--- a/lib/libc/sys/mincore.2    Mon Jul 25 22:43:01 2022 +0000
+++ b/lib/libc/sys/mincore.2    Mon Jul 25 22:50:42 2022 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: mincore.2,v 1.19 2004/05/13 10:20:58 wiz Exp $
+.\"    $NetBSD: mincore.2,v 1.20 2022/07/25 22:50:42 riastradh Exp $
 .\"
 .\" Copyright (c) 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -44,14 +44,16 @@
 .Sh DESCRIPTION
 The
 .Fn mincore
-system call
-allows a process to obtain information about whether pages are
-core resident.
+system call tells whether the pages covering
+.Fa len
+bytes of data starting at
+.Fa addr
+are core resident in the process.
 The status of the memory range is returned in the character-per-page array
-.Ar vec .
+.Fa vec .
 If the page is resident, the least significant bit of the corresponding
 character in
-.Ar vec
+.Fa vec
 will be set.
 Other bits are reserved for additional information
 which future implementations may return.
@@ -73,13 +75,13 @@
 call will fail if:
 .Bl -tag -width Er
 .It Bq Er EFAULT
-.Ar vec
+.Fa vec
 points to an illegal address.
 .It Bq Er EINVAL
-.Ar addr
+.Fa addr
 is not a multiple of the system page size.
 .It Bq Er EINVAL
-.Ar len
+.Fa len
 is equal to 0.
 .It Bq Er ENOMEM
 The address range specified is invalid for the calling process,



Home | Main Index | Thread Index | Old Index