From gavin@FreeBSD.org  Wed Dec  3 20:08:43 2008
Return-Path: <gavin@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id DC8DA1065676
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  3 Dec 2008 20:08:42 +0000 (UTC)
	(envelope-from gavin@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28])
	by mx1.freebsd.org (Postfix) with ESMTP id CABED8FC1B
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  3 Dec 2008 20:08:42 +0000 (UTC)
	(envelope-from gavin@FreeBSD.org)
Received: from freefall.freebsd.org (gavin@localhost [127.0.0.1])
	by freefall.freebsd.org (8.14.3/8.14.3) with ESMTP id mB3K8gMi003279
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 3 Dec 2008 20:08:42 GMT
	(envelope-from gavin@freefall.freebsd.org)
Received: (from gavin@localhost)
	by freefall.freebsd.org (8.14.3/8.14.3/Submit) id mB3K8glp003278;
	Wed, 3 Dec 2008 20:08:42 GMT
	(envelope-from gavin)
Message-Id: <200812032008.mB3K8glp003278@freefall.freebsd.org>
Date: Wed, 3 Dec 2008 20:08:42 GMT
From: Gavin Atkinson <gavin@freebsd.org>
Reply-To: Gavin Atkinson <gavin@freebsd.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: various tweaks to ddb-related man pages
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         129398
>Category:       docs
>Synopsis:       [patch] ddb(8): various tweaks to ddb-related man pages
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 03 20:10:03 UTC 2008
>Closed-Date:    Sat Jul 21 15:49:37 UTC 2012
>Last-Modified:  Sat Jul 21 15:49:37 UTC 2012
>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@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:
State-Changed-From-To: open->patched 
State-Changed-By: trhodes 
State-Changed-When: Wed Dec 24 11:13:06 UTC 2008 
State-Changed-Why:  
Patch applied with only one minor change.  Thanks Gavin! 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Wed Dec 24 11:13:06 UTC 2008 
Responsible-Changed-Why:  
Over to me, MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=129398 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/129398: commit references a PR
Date: Wed, 24 Dec 2008 11:12:35 +0000 (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"
 
State-Changed-From-To: patched->closed 
State-Changed-By: trhodes 
State-Changed-When: Sat Jul 21 15:49:22 UTC 2012 
State-Changed-Why:  
Changes have been merged for awhile now, thanks. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=129398 
>Unformatted:
