From garys@opusnet.com  Sun Aug 21 15:11:51 2005
Return-Path: <garys@opusnet.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id A374816A41F
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 21 Aug 2005 15:11:51 +0000 (GMT)
	(envelope-from garys@opusnet.com)
Received: from opusnet.com (mail.opusnet.com [209.210.200.6])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 5328C43D46
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 21 Aug 2005 15:11:51 +0000 (GMT)
	(envelope-from garys@opusnet.com)
Received: from localhost.localhost [70.98.246.232] by opusnet.com with ESMTP
  (SMTPD32-8.05) id A9B3FC700CA; Sun, 21 Aug 2005 08:11:47 -0700
Received: from localhost.localhost (localhost.localhost [127.0.0.1])
	by localhost.localhost (8.13.3/8.13.3) with ESMTP id j7LFD9V7032197
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 21 Aug 2005 08:13:09 -0700 (PDT)
	(envelope-from garys@opusnet.com)
Received: (from jojo@localhost)
	by localhost.localhost (8.13.3/8.13.3/Submit) id j7LFD4vR032196;
	Sun, 21 Aug 2005 08:13:04 -0700 (PDT)
	(envelope-from garys@opusnet.com)
Message-Id: <3rbr3rnx1b.r3r@mail.opusnet.com>
Date: Sun, 21 Aug 2005 08:13:04 -0700
From: "Gary W. Swearingen" <garys@opusnet.com>
Reply-To: garys@opusnet.com
To: FreeBSD-gnats-submit@freebsd.org
Subject: ktrace(1) manpage doesn't warn about need for KTRACE
X-GNATS-Notify:

>Number:         85186
>Category:       docs
>Synopsis:       [patch] ktrace(1) manpage doesn't warn about need for KTRACE
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Aug 21 15:20:06 GMT 2005
>Closed-Date:    Mon Nov 06 15:18:57 GMT 2006
>Last-Modified:  Mon Nov 20 17:40:20 GMT 2006
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:

1) ktrace(1) manpage doesn't warn about need for KTRACE
I'm basing that on KTRACE's comment in the Handbook:
    "ktrace(1) support"

2) It omits needed hyphens.

3) It uses redundant "as follows".

>How-To-Repeat:
>Fix:

--- ktrace..orig.1	Sat Aug 20 14:42:44 2005
+++ ktrace.1	Sat Aug 20 14:49:53 2005
@@ -64,7 +64,7 @@
 A traced process can generate enormous amounts of log data quickly;
 It is strongly suggested that users memorize how to disable tracing before
 attempting to trace a process.
-The following command is sufficient to disable tracing on all user owned
+The following command is sufficient to disable tracing on all user-owned
 processes, and, if executed by root, all processes:
 .Pp
 .Dl \&$ ktrace -C
@@ -73,12 +73,16 @@
 .Xr kdump 1
 to decode it.
 .Pp
-The options are as follows:
+The utility should be used only with a kernel that has been built with the
+.Dq KTRACE
+option in the kernel configuration file.
+.Pp
+The options are:
 .Bl -tag -width indent
 .It Fl a
 Append to the trace file instead of recreating it.
 .It Fl C
-Disable tracing on all user owned processes, and, if executed by root, all
+Disable tracing on all user-owned processes, and, if executed by root, all
 processes in the system.
 .It Fl c
 Clear the trace points associated with the specified file or processes.
@@ -160,7 +164,7 @@
 # disable all tracing to the file "tracedata"
 .Dl $ ktrace -c -f tracedata
 .Pp
-# disable tracing of all processes owned by the user
+# disable tracing of all user-owned processes
 .Dl $ ktrace -C
 .Sh SEE ALSO
 .Xr kdump 1
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Mon Nov 6 15:18:03 UTC 2006 
State-Changed-Why:  
Patch committed with a minor wording change and a bumped 
doc date.  Thanks for the submission! 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Mon Nov 6 15:18:03 UTC 2006 
Responsible-Changed-Why:  
Over to me, MFC reminder. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/85186: commit references a PR
Date: Mon,  6 Nov 2006 15:21:04 +0000 (UTC)

 trhodes     2006-11-06 15:17:50 UTC
 
   FreeBSD src repository
 
   Modified files:
     usr.bin/ktrace       ktrace.1 
   Log:
   Add needed hyphens, note the KTRACE kernel option, bump doc date.
   
   PR:             85186
   Submitted by:   garys
   
   Revision  Changes    Path
   1.18      +9 -5      src/usr.bin/ktrace/ktrace.1
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/85186: commit references a PR
Date: Mon, 20 Nov 2006 17:37:40 +0000 (UTC)

 trhodes     2006-11-20 17:29:12 UTC
 
   FreeBSD src repository
 
   Modified files:        (Branch: RELENG_6)
     usr.bin/ktrace       ktrace.1 
   Log:
   MFC Rev 1.18:
   
   Add needed hyphens, note the KTRACE kernel option, bump doc date.
   
   PR:             85186
   Submitted by:   garys
   
   Revision  Changes    Path
   1.17.2.1  +9 -5      src/usr.bin/ktrace/ktrace.1
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
>Unformatted:
