* [PATCH] BSD libkvm documentation
@ 2004-07-03 13:32 Mark Kettenis
2004-07-03 21:09 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Mark Kettenis @ 2004-07-03 13:32 UTC (permalink / raw)
To: eliz, gdb-patches
Eli, are these doc bits OK?
Mark
Index: doc/ChangeLog
from Mark Kettenis <kettenis@gnu.org>
* gdb.texinfo (BSD libkvm Interface): New node (section)
(Native): Add it to the menu.
Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.207
diff -u -p -r1.207 gdb.texinfo
--- doc/gdb.texinfo 19 Jun 2004 17:33:44 -0000 1.207
+++ doc/gdb.texinfo 3 Jul 2004 13:31:22 -0000
@@ -11412,6 +11412,7 @@ configurations.
@menu
* HP-UX:: HP-UX
+* BSD libkvm Interface:: Debugging BSD kernel memory images
* SVR4 Process Information:: SVR4 process information
* DJGPP Native:: Features specific to the DJGPP port
* Cygwin Native:: Features specific to the Cygwin port
@@ -11424,6 +11425,47 @@ On HP-UX systems, if you refer to a func
begins with a dollar sign, @value{GDBN} searches for a user or system
name first, before it searches for a convenience variable.
+@node BSD libkvm Interface
+@subsection BSD libkvm Interface
+
+@kindex libkvm
+@cindex kernel memory image
+@cindex kernel crash dump
+
+BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
+interface that provides a uniform interface for accessing kernel virtual
+memory images, including live systems and crash dumps. @value{GDBN}
+uses this interface to allow you to debug live kernels and kernel crash
+dumps on many native BSD configurations. This is implemented as a
+special @code{kvm} debugging target. For debugging a live system, load
+the currently running kernel into @value{GDBN} and connect to the
+@code{kvm} target:
+
+@smallexample
+(@value{GDBP}) @b{target kvm}
+@end smallexample
+
+For debugging crash dumps, provide the file name of the crash dump as an
+argument:
+
+@smallexample
+(@value{GDBP}) @b{target kvm /var/crash/bsd.0}
+@end smallexample
+
+Once connected to the @code{kvm} target, the following commands are
+available:
+
+@table @code
+@kindex kvm pcb
+@item kvm pcb
+Set current context from pcb address.
+
+@kindex kvm proc
+@item kvm proc
+Set current context from proc address. This command isn't available on
+modern FreeBSD systems.
+@end table
+
@node SVR4 Process Information
@subsection SVR4 process information
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH] BSD libkvm documentation
2004-07-03 13:32 [PATCH] BSD libkvm documentation Mark Kettenis
@ 2004-07-03 21:09 ` Eli Zaretskii
2004-07-04 7:03 ` Mark Kettenis
0 siblings, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2004-07-03 21:09 UTC (permalink / raw)
To: Mark Kettenis; +Cc: gdb-patches
> Date: Sat, 3 Jul 2004 15:32:15 +0200 (CEST)
> From: Mark Kettenis <kettenis@chello.nl>
>
> Eli, are these doc bits OK?
Yes, but please fix these small gotchas before you commit:
> +@node BSD libkvm Interface
> +@subsection BSD libkvm Interface
> +
> +@kindex libkvm
"libkvm" is not a command, right? If so, @kindex is wrong here;
please use eithe @cindex or @pindex.
> +@table @code
> +@kindex kvm pcb
> +@item kvm pcb
> +Set current context from pcb address.
> +
> +@kindex kvm proc
> +@item kvm proc
There's no reason to have 2 index entries both starting with "kvm"
and both pointing to the same page; it just bloats the index. Please
leave only the first @kindex entry and make it say just "@kindex kvm".
Thanks.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] BSD libkvm documentation
2004-07-03 21:09 ` Eli Zaretskii
@ 2004-07-04 7:03 ` Mark Kettenis
2004-07-04 19:14 ` Eli Zaretskii
2004-07-09 18:52 ` Eli Zaretskii
0 siblings, 2 replies; 6+ messages in thread
From: Mark Kettenis @ 2004-07-04 7:03 UTC (permalink / raw)
To: eliz; +Cc: gdb-patches
Date: Sun, 04 Jul 2004 00:09:30 +0200
From: "Eli Zaretskii" <eliz@gnu.org>
> Date: Sat, 3 Jul 2004 15:32:15 +0200 (CEST)
> From: Mark Kettenis <kettenis@chello.nl>
>
> Eli, are these doc bits OK?
Yes, but please fix these small gotchas before you commit:
Thanks, but:
> +@table @code
> +@kindex kvm pcb
> +@item kvm pcb
> +Set current context from pcb address.
> +
> +@kindex kvm proc
> +@item kvm proc
There's no reason to have 2 index entries both starting with "kvm"
and both pointing to the same page; it just bloats the index. Please
leave only the first @kindex entry and make it say just "@kindex kvm".
There may be more "kvm" commands in the future, such that the section
doesn't fit on a single page anymore. Also it seems that current
practice is to give every command a @kindex entry.
Mark
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] BSD libkvm documentation
2004-07-04 7:03 ` Mark Kettenis
@ 2004-07-04 19:14 ` Eli Zaretskii
2004-07-05 16:04 ` Mark Kettenis
2004-07-09 18:52 ` Eli Zaretskii
1 sibling, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2004-07-04 19:14 UTC (permalink / raw)
To: Mark Kettenis; +Cc: gdb-patches
> Date: Sun, 4 Jul 2004 09:03:04 +0200 (CEST)
> From: Mark Kettenis <kettenis@chello.nl>
>
> There's no reason to have 2 index entries both starting with "kvm"
> and both pointing to the same page; it just bloats the index. Please
> leave only the first @kindex entry and make it say just "@kindex kvm".
>
> There may be more "kvm" commands in the future, such that the section
> doesn't fit on a single page anymore.
That doesn't really matter, since they all are described one after
the other.
> Also it seems that current practice is to give every command a
> @kindex entry.
We should fix all such entries.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] BSD libkvm documentation
2004-07-04 19:14 ` Eli Zaretskii
@ 2004-07-05 16:04 ` Mark Kettenis
0 siblings, 0 replies; 6+ messages in thread
From: Mark Kettenis @ 2004-07-05 16:04 UTC (permalink / raw)
To: eliz; +Cc: gdb-patches
Date: Sun, 04 Jul 2004 22:14:24 +0200
From: "Eli Zaretskii" <eliz@gnu.org>
> Date: Sun, 4 Jul 2004 09:03:04 +0200 (CEST)
> From: Mark Kettenis <kettenis@chello.nl>
>
> There's no reason to have 2 index entries both starting with "kvm"
> and both pointing to the same page; it just bloats the index. Please
> leave only the first @kindex entry and make it say just "@kindex kvm".
>
> There may be more "kvm" commands in the future, such that the section
> doesn't fit on a single page anymore.
That doesn't really matter, since they all are described one after
the other.
> Also it seems that current practice is to give every command a
> @kindex entry.
We should fix all such entries.
Fair enough. Thanks for the explanation. I committed the attached.
Mark
Index: doc/ChangeLog
from Mark Kettenis <kettenis@gnu.org>
* gdb.texinfo (BSD libkvm Interface): New node (section)
(Native): Add it to the menu.
Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.207
diff -u -p -r1.207 gdb.texinfo
--- doc/gdb.texinfo 19 Jun 2004 17:33:44 -0000 1.207
+++ doc/gdb.texinfo 5 Jul 2004 15:27:48 -0000
@@ -11412,6 +11412,7 @@ configurations.
@menu
* HP-UX:: HP-UX
+* BSD libkvm Interface:: Debugging BSD kernel memory images
* SVR4 Process Information:: SVR4 process information
* DJGPP Native:: Features specific to the DJGPP port
* Cygwin Native:: Features specific to the Cygwin port
@@ -11424,6 +11425,46 @@ On HP-UX systems, if you refer to a func
begins with a dollar sign, @value{GDBN} searches for a user or system
name first, before it searches for a convenience variable.
+@node BSD libkvm Interface
+@subsection BSD libkvm Interface
+
+@cindex libkvm
+@cindex kernel memory image
+@cindex kernel crash dump
+
+BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
+interface that provides a uniform interface for accessing kernel virtual
+memory images, including live systems and crash dumps. @value{GDBN}
+uses this interface to allow you to debug live kernels and kernel crash
+dumps on many native BSD configurations. This is implemented as a
+special @code{kvm} debugging target. For debugging a live system, load
+the currently running kernel into @value{GDBN} and connect to the
+@code{kvm} target:
+
+@smallexample
+(@value{GDBP}) @b{target kvm}
+@end smallexample
+
+For debugging crash dumps, provide the file name of the crash dump as an
+argument:
+
+@smallexample
+(@value{GDBP}) @b{target kvm /var/crash/bsd.0}
+@end smallexample
+
+Once connected to the @code{kvm} target, the following commands are
+available:
+
+@table @code
+@kindex kvm
+@item kvm pcb
+Set current context from pcb address.
+
+@item kvm proc
+Set current context from proc address. This command isn't available on
+modern FreeBSD systems.
+@end table
+
@node SVR4 Process Information
@subsection SVR4 process information
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] BSD libkvm documentation
2004-07-04 7:03 ` Mark Kettenis
2004-07-04 19:14 ` Eli Zaretskii
@ 2004-07-09 18:52 ` Eli Zaretskii
1 sibling, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2004-07-09 18:52 UTC (permalink / raw)
To: gdb-patches
> Date: Sun, 4 Jul 2004 09:03:04 +0200 (CEST)
> From: Mark Kettenis <kettenis@chello.nl>
>
> Also it seems that current practice is to give every command a
> @kindex entry.
I've now fixed all such entries[1] so that if there are a few commands
with a common prefix, say "foo bar", then only "@kindex foo bar" is in
the index. Where appropriate, I added @cindex entries to help find
the relevant info via index search.
Let me know if some of the changes I made need more work.
Footnotes:
[1] Well, almost all such entries: there are borderline cases such as
for the command `set', `show', `info', `maint', etc., that are
scattered through the entire manual, and it is neither practical nor
IMHO desirable to remove them.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2004-07-09 18:52 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2004-07-03 13:32 [PATCH] BSD libkvm documentation Mark Kettenis
2004-07-03 21:09 ` Eli Zaretskii
2004-07-04 7:03 ` Mark Kettenis
2004-07-04 19:14 ` Eli Zaretskii
2004-07-05 16:04 ` Mark Kettenis
2004-07-09 18:52 ` Eli Zaretskii
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox