[src/trunk]: src/lib/libkvm Make the documentation match reality. If no expl...

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

details:   https://anonhg.NetBSD.org/src/rev/590a47eca76f
branches:  trunk
changeset: 747437:590a47eca76f
user:      apb <apb%NetBSD.org@localhost>
date:      Mon Sep 14 19:34:12 2009 +0000

description:
Make the documentation match reality.  If no explicit kernel name is
provided, kvm_open() and kvm_openfiles() will try _PATH_KSYMS first,
then either the path from sysctl machdep.booted_kernel (if that's
available) or _PATH_UNIX (if the sysctl is not available).

diffstat:

 lib/libkvm/kvm_open.3 |  19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)

diffs (40 lines):

diff -r 39a88e36f6d2 -r 590a47eca76f lib/libkvm/kvm_open.3
--- a/lib/libkvm/kvm_open.3     Mon Sep 14 19:29:20 2009 +0000
+++ b/lib/libkvm/kvm_open.3     Mon Sep 14 19:34:12 2009 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: kvm_open.3,v 1.15 2009/03/10 23:49:07 joerg Exp $
+.\"    $NetBSD: kvm_open.3,v 1.16 2009/09/14 19:34:12 apb Exp $
 .\"
 .\" Copyright (c) 1992, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -33,7 +33,7 @@
 .\"
 .\"     @(#)kvm_open.3 8.3 (Berkeley) 4/19/94
 .\"
-.Dd April 19, 1994
+.Dd September 14, 2009
 .Dt KVM_OPEN 3
 .Os
 .Sh NAME
@@ -69,8 +69,19 @@
 This file must contain a symbol table.
 If this argument is
 .Dv NULL ,
-the currently running system is assumed,
-which is indicated by
+the currently running system is assumed; in this case, the functions will
+attempt to use the
+.Xr ksyms 4
+device indicated by
+.Dv _PATH_KSYMS
+in
+.Aq Pa paths.h ;
+if that fails, then they will use the file indicated by the
+.Xr sysctl 3
+variable
+.Va machdep.booted_kernel ,
+or (if the sysctl information is not available)
+the default kernel path indicated by
 .Dv _PATH_UNIX
 in
 .Aq Pa paths.h .