[src/trunk]: src/share/man/man9/man9.i386 .Nm -> .Fn, and wrap the kernel con...

[jruoho <jruoho%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c2454c807a9c
branches:  trunk
changeset: 754588:c2454c807a9c
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Wed May 05 05:43:19 2010 +0000

description:
.Nm -> .Fn, and wrap the kernel config option so that it will fit into 80
columns.

diffstat:

 share/man/man9/man9.i386/return_address.9 |  27 +++++++++++++++------------
 1 files changed, 15 insertions(+), 12 deletions(-)

diffs (75 lines):

diff -r c2a100869c30 -r c2454c807a9c share/man/man9/man9.i386/return_address.9
--- a/share/man/man9/man9.i386/return_address.9 Wed May 05 05:36:21 2010 +0000
+++ b/share/man/man9/man9.i386/return_address.9 Wed May 05 05:43:19 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: return_address.9,v 1.2 2009/11/03 11:04:32 wiz Exp $
+.\"    $NetBSD: return_address.9,v 1.3 2010/05/05 05:43:19 jruoho Exp $
 .\"
 .\" Copyright (c) 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd November 2, 2009
+.Dd May 5, 2010
 .Dt RETURN_ADDRESS 9 i386
 .Os
 .Sh NAME
@@ -39,7 +39,7 @@
 .Fn return_address "unsigned int level"
 .Sh DESCRIPTION
 The
-.Nm
+.Fn return_address
 function evaluates to the first return address on the call stack
 if
 .Fa level
@@ -52,27 +52,29 @@
 the call stack.
 .Pp
 A special fault handler stops
-.Nm
+.Fn return_address
 from crashing the kernel by examining a non-existent or corrupt stack
 frame.
 .Pp
 Kernel compilation options affect both the ability of
-.Nm
+.Fn return_address
 to locate return addresses on the stack, and the programmer's
 ability to interpret the addresses.
 The compiler may optimize away the stack frame pointers that
-.Nm
+.Fn return_address
 depends on.
+.Pp
 To use
-.Nm
+.Fn return_address
 effecively, try a kernel configuration option such as
 .Bd -literal
-makeoptions     DEBUG="-g -fno-omit-frame-pointer -fno-optimize-sibling-calls -O0"
+makeoptions     DEBUG="-g -fno-omit-frame-pointer \\
+                      -fno-optimize-sibling-calls -O0"
 .Ed
 .Sh RETURN VALUES
-.Nm
-returns the
-requested return address, or
+The
+.Fn return_address
+returns the requested return address, or
 .Dv NULL
 if it cannot dissect the call stack.
 .Sh CODE REFERENCES
@@ -81,7 +83,8 @@
 .Sh REFERENCES
 .Xr config 5
 .Sh HISTORY
-.Nm
+The
+.Fn return_address
 first appeared in
 .Nx 6.0 .
 .Sh AUTHORS