summaryrefslogtreecommitdiff
path: root/share/man/man9
diff options
context:
space:
mode:
authorArtur Grabowski <art@cvs.openbsd.org>2002-12-20 06:10:28 +0000
committerArtur Grabowski <art@cvs.openbsd.org>2002-12-20 06:10:28 +0000
commit36e3e0e7e56c96158dce69456feed353d92db7d6 (patch)
tree95d88f5b07a4e4ffe2a8d384035fe7584cf8cf12 /share/man/man9
parentd44e99bee495b325f52f032140ff3a2d893ea8ab (diff)
Reword the DEBUGGING section to get rid of second person forms.
Diffstat (limited to 'share/man/man9')
-rw-r--r--share/man/man9/malloc.921
1 files changed, 10 insertions, 11 deletions
diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9
index 216e0b90934..72566e11f1e 100644
--- a/share/man/man9/malloc.9
+++ b/share/man/man9/malloc.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: malloc.9,v 1.21 2002/12/20 06:05:31 art Exp $
+.\" $OpenBSD: malloc.9,v 1.22 2002/12/20 06:10:27 art Exp $
.\" $NetBSD: malloc.9,v 1.2 1996/10/30 05:29:54 lukem Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
@@ -408,19 +408,18 @@ panic:
.Sh DEBUGGING
A kernel compiled with the
.Cm MALLOC_DEBUG
-option allows for more extensive
-debugging of memory allocations.
-You can choose which allocation to debug with the
+option allows for more extensive debugging of memory allocations.
+The
.Va debug_malloc_type ,
.Va debug_malloc_size ,
.Va debug_malloc_size_lo
and
.Va debug_malloc_size_hi
-variables.
+variables choose which allocation to debug.
.Va debug_malloc_type
should be set to the memory type and
.Va debug_malloc_size
-should be set to the memory size you want to debug.
+should be set to the memory size to debug.
0 can be used as a wildcard.
.Va debug_malloc_size_lo
and
@@ -452,17 +451,17 @@ freed memory.
There are no special diagnostics if any errors are caught by the debugging
malloc.
The errors will look like normal access to unmapped memory.
-When you get a memory access error, invoke the
+On a memory access error, the
.Ic show malloc
command in
.Xr ddb 4
-to see what memory areas are allocated and freed.
+can be invoked to see what memory areas are allocated and freed.
If the faulting address is within two pages from an address on the allocated
-list, you have gotten an access outside the allocated area.
+list, there was an access outside the allocated area.
If the faulting address is within two pages from an address on the free list,
-you have gotten an access to freed memory.
+there was an access to freed memory.
.Pp
-You have to be very careful when using the
+Care needs to be taken when using the
.Cm MALLOC_DEBUG
option: the memory consumption can run away pretty quickly and there is
a severe performance degradation when allocating and freeing debugged memory