docs/129398: various tweaks to ddb-related man pages

Gavin Atkinson gavin at FreeBSD.org
Wed Dec 3 20:10:04 UTC 2008


>Number:         129398
>Category:       docs
>Synopsis:       various tweaks to ddb-related man pages
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 03 20:10:03 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gavin Atkinson
>Release:        FreeBSD 7.1-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD freefall.freebsd.org 7.1-PRERELEASE FreeBSD 7.1-PRERELEASE #35: Sun Oct 12 12:45:36 UTC 2008 simon at freefall.freebsd.org:/usr/src/sys/i386/compile/FREEFALL i386

>Description:
	Tweaks to ddb(8), savecore(8) and textdump(4):
ddb(8): Remove .Ic from text which is not an interactive command, and 
add an .El (removes warnings during render)
savecore(8): Fix an xref
textdump(8): add a useful bit of info and an xref

I haven't bumped .Dd on ddb(8) as this shouldn't affect the rendered man page.
>How-To-Repeat:
	N/A
>Fix:

--- 20081203-manpages-ddb.diff begins here ---
Index: src/sbin/ddb/ddb.8
===================================================================
RCS file: /home/ncvs/src/sbin/ddb/ddb.8,v
retrieving revision 1.6
diff -u -r1.6 ddb.8
--- src/sbin/ddb/ddb.8	3 Aug 2008 14:27:06 -0000	1.6
+++ src/sbin/ddb/ddb.8	3 Dec 2008 20:05:24 -0000
@@ -87,7 +87,7 @@
 The following debugger commands are available from the command line:
 .Bl -tag -width indent
 .It Xo
-.Ic Cm capture
+.Cm capture
 .Op Fl M Ar core
 .Op Fl N Ar system
 .Cm print
@@ -96,7 +96,7 @@
 .Xr ddb 4
 output capture buffer.
 .It Xo
-.Ic Cm capture
+.Cm capture
 .Op Fl M Ar core
 .Op Fl N Ar system
 .Cm status
@@ -104,6 +104,7 @@
 Print the current status of the
 .Xr ddb 4
 output capture buffer.
+.El
 .Sh SCRIPTING
 The
 .Nm
Index: src/sbin/savecore/savecore.8
===================================================================
RCS file: /home/ncvs/src/sbin/savecore/savecore.8,v
retrieving revision 1.26
diff -u -r1.26 savecore.8
--- src/sbin/savecore/savecore.8	26 Dec 2007 11:42:10 -0000	1.26
+++ src/sbin/savecore/savecore.8	3 Dec 2008 19:17:13 -0000
@@ -28,7 +28,7 @@
 .\"     From: @(#)savecore.8	8.1 (Berkeley) 6/5/93
 .\" $FreeBSD: src/sbin/savecore/savecore.8,v 1.26 2007/12/26 11:42:10 rwatson Exp $
 .\"
-.Dd February 24, 2005
+.Dd December 3, 2008
 .Dt SAVECORE 8
 .Os
 .Sh NAME
@@ -144,7 +144,7 @@
 .Xr gzip 1 ,
 .Xr getbootfile 3 ,
 .Xr textdump 4 ,
-.Xr tar 4 ,
+.Xr tar 5 ,
 .Xr dumpon 8 ,
 .Xr syslogd 8
 .Sh HISTORY
Index: src/share/man/man4/textdump.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/textdump.4,v
retrieving revision 1.5
diff -u -r1.5 textdump.4
--- src/share/man/man4/textdump.4	3 Aug 2008 14:14:43 -0000	1.5
+++ src/share/man/man4/textdump.4	3 Dec 2008 19:17:23 -0000
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD: src/share/man/man4/textdump.4,v 1.5 2008/08/03 14:14:43 rwatson Exp $
 .\"
-.Dd December 26, 2007
+.Dd December 3, 2008
 .Dt textdump 4
 .Os
 .Sh NAME
@@ -148,10 +148,15 @@
 .Bd -literal -offset indent
 script kdb.enter.witness=show locks
 .Ed
+.Pp
+These scripts may also be configured from userspace using the
+.Xr ddb 8
+command.
 .Sh SEE ALSO
 .Xr bsdtar 1 ,
 .Xr ddb 4 ,
 .Xr tar 5 ,
+.Xr ddb 8 ,
 .Xr dumpon 8 ,
 .Xr savecore 8 ,
 .Xr sysctl 8
--- 20081203-manpages-ddb.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list