Bug 129398

Summary: [patch] ddb(8): various tweaks to ddb-related man pages
Product: Documentation Reporter: Gavin Atkinson <gavin>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
20081203-manpages-ddb.diff none

Description Gavin Atkinson freebsd_committer freebsd_triage 2008-12-03 20:10:03 UTC
	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
Comment 1 dfilter service freebsd_committer freebsd_triage 2008-12-24 11:12:35 UTC
Author: trhodes
Date: Wed Dec 24 11:12:21 2008
New Revision: 186478
URL: http://svn.freebsd.org/changeset/base/186478

Log:
  Apply various fixes:
  
  Silence mdoc(7) warnings;
  Xref correct manual pages;
  Point user to the ddb.8 manual page.
  
  PR:		129398
  Submitted by:	gavin

Modified:
  head/sbin/ddb/ddb.8
  head/sbin/savecore/savecore.8
  head/share/man/man4/textdump.4

Modified: head/sbin/ddb/ddb.8
==============================================================================
--- head/sbin/ddb/ddb.8	Wed Dec 24 10:08:39 2008	(r186477)
+++ head/sbin/ddb/ddb.8	Wed Dec 24 11:12:21 2008	(r186478)
@@ -25,7 +25,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 24, 2008
+.Dd December 24, 2008
 .Dt DDB 8
 .Os
 .Sh NAME
@@ -87,7 +87,7 @@ kernel on disk.
 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 @@ Print the current contents of the
 .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 @@ output capture buffer.
 Print the current status of the
 .Xr ddb 4
 output capture buffer.
+.El
 .Sh SCRIPTING
 The
 .Nm

Modified: head/sbin/savecore/savecore.8
==============================================================================
--- head/sbin/savecore/savecore.8	Wed Dec 24 10:08:39 2008	(r186477)
+++ head/sbin/savecore/savecore.8	Wed Dec 24 11:12:21 2008	(r186478)
@@ -28,7 +28,7 @@
 .\"     From: @(#)savecore.8	8.1 (Berkeley) 6/5/93
 .\" $FreeBSD$
 .\"
-.Dd February 24, 2005
+.Dd December 24, 2008
 .Dt SAVECORE 8
 .Os
 .Sh NAME
@@ -144,7 +144,7 @@ is meant to be called near the end of th
 .Xr gzip 1 ,
 .Xr getbootfile 3 ,
 .Xr textdump 4 ,
-.Xr tar 4 ,
+.Xr tar 5 ,
 .Xr dumpon 8 ,
 .Xr syslogd 8
 .Sh HISTORY

Modified: head/share/man/man4/textdump.4
==============================================================================
--- head/share/man/man4/textdump.4	Wed Dec 24 10:08:39 2008	(r186477)
+++ head/share/man/man4/textdump.4	Wed Dec 24 11:12:21 2008	(r186478)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 26, 2007
+.Dd December 24, 2008
 .Dt textdump 4
 .Os
 .Sh NAME
@@ -148,10 +148,15 @@ violation, printing lock-related informa
 .Bd -literal -offset indent
 script kdb.enter.witness=show locks
 .Ed
+.Pp
+These scripts may also be configured using the
+.Xr ddb 8
+utility.
 .Sh SEE ALSO
 .Xr bsdtar 1 ,
 .Xr ddb 4 ,
 .Xr tar 5 ,
+.Xr ddb 8 ,
 .Xr dumpon 8 ,
 .Xr savecore 8 ,
 .Xr sysctl 8
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2008-12-24 11:13:06 UTC
State Changed
From-To: open->patched

Patch applied with only one minor change.  Thanks Gavin! 


Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2008-12-24 11:13:06 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Over to me, MFC reminder.
Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2012-07-21 16:49:22 UTC
State Changed
From-To: patched->closed

Changes have been merged for awhile now, thanks.