[src/trunk]: src/doc Document MKCROSSGDB, MKKDEBUG and build.sh kernel.gdb=

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

details:   https://anonhg.NetBSD.org/src/rev/4222024715fa
branches:  trunk
changeset: 796076:4222024715fa
user:      martin <martin%NetBSD.org@localhost>
date:      Mon May 19 10:12:19 2014 +0000

description:
Document MKCROSSGDB, MKKDEBUG and build.sh kernel.gdb=

diffstat:

 doc/BUILDING.mdoc |  30 +++++++++++++++++++++++++++++-
 1 files changed, 29 insertions(+), 1 deletions(-)

diffs (58 lines):

diff -r c7efafcfa400 -r 4222024715fa doc/BUILDING.mdoc
--- a/doc/BUILDING.mdoc Mon May 19 09:56:17 2014 +0000
+++ b/doc/BUILDING.mdoc Mon May 19 10:12:19 2014 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: BUILDING.mdoc,v 1.97 2014/05/19 09:56:17 martin Exp $
+.\"    $NetBSD: BUILDING.mdoc,v 1.98 2014/05/19 10:12:19 martin Exp $
 .\"
 .\" Copyright (c) 2001-2011 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -437,6 +437,11 @@
 during a build.
 .DFLTn
 .
+.It Sy MKCROSSGDB
+.YorN
+Create a cross-gdb as a host tool.
+.DFLTn
+.
 .It Sy MKCRYPTO
 .YorN
 Indicates whether cryptographic code will be included in a build;
@@ -500,6 +505,18 @@
 build.
 .DFLTy
 .
+.It Sy MKKDEBUG
+.YorN
+Force generation of full-debug symbol versions of all kernels compiled.
+Alongside of the
+.Pa netbsd
+kernel file, an unstripped version
+.Pa netbsd.gdb
+is created.
+This is usfull if a cross-gdb is build as well (see
+.Sy MKCROSSGDB ) .
+.DFLTn
+.
 .It Sy MKKMOD
 .YorN
 Indicates whether kernel modules are built and installed.
@@ -1448,6 +1465,17 @@
 .Fl u
 option is given.
 .
+.It Sy kernel.gdb Ns = Ns Ar kconf
+Build a new kernel with debug information.
+Similar to the above
+.Sy kernel Ns = Ns Ar kconf
+operation, but creates a
+.Pa netbsd.gdb
+file alongside of the kernel
+.Pa netbsd ,
+which contains a full symbol table and can be used for debugging
+(for example with a cross-gdb build by
+.Sy MKCROSSGDB ) .
 .It Sy modules
 This command will build kernel modules and install them into
 .Sy DESTDIR .