Bug 34668

Summary: Document '+' for -t in ktrace(1)
Product: Documentation Reporter: Stefan Farfeleder <e0026813>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Stefan Farfeleder 2002-02-06 17:00:06 UTC
The -t option takes a string of characters, of which '+' wasn't documented    till now. Wording taken from NetBSD ktrace(1).

Additional problem: kdump(1) refers to ktrace(1) for information about -t, but while ktrace defaults to DEF_POINTS (-t +), kdump has ALL_POINTS (-t +w) when no -t option is given.
Comment 1 Peter Pentchev 2002-02-07 08:21:13 UTC
On Wed, Feb 06, 2002 at 08:51:58AM -0800, Stefan Farfeleder wrote:
> 
> >Number:         34668
> >Category:       docs
> >Synopsis:       Document '+' for -t in ktrace(1)
> >Originator:     Stefan Farfeleder
> 
> >Description:
> The -t option takes a string of characters, of which '+' wasn't documented    till now. Wording taken from NetBSD ktrace(1).
> 
> Additional problem: kdump(1) refers to ktrace(1) for information about -t, but while ktrace defaults to DEF_POINTS (-t +), kdump has ALL_POINTS (-t +w) when no -t option is given.
> >How-To-Repeat:
> 
> >Fix:
> --- ktrace.1.orig       Wed Feb  6 16:05:12 2002
> +++ ktrace.1    Wed Feb  6 16:40:44 2002
> @@ -119,6 +119,8 @@
>  userland traces
>  .It Cm w
>  context switches
> +.It Cm +
> +trace the default set of trace points (c, n, i, s, u)
>  .El
>  .It Ar command
>  Execute


Would it not be better to mark those up as Cm's, as in
the attached patch?
G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
This sentence contains exactly threee erors.

Index: src/usr.bin/ktrace/ktrace.1
===================================================================
RCS file: /home/ncvs/src/usr.bin/ktrace/ktrace.1,v
retrieving revision 1.13
diff -u -r1.13 ktrace.1
--- src/usr.bin/ktrace/ktrace.1	15 Jul 2001 08:01:20 -0000	1.13
+++ src/usr.bin/ktrace/ktrace.1	7 Feb 2002 08:19:48 -0000
@@ -119,6 +119,13 @@
 userland traces
 .It Cm w
 context switches
+.It Cm +
+trace the default set of trace points -
+.Cm c ,
+.Cm n ,
+.Cm i ,
+.Cm s ,
+.Cm u
 .El
 .It Ar command
 Execute
Comment 2 Peter Pentchev 2002-02-07 08:30:56 UTC
Hmm.. is this your correct e-mail address?  I got a 'mail delivery
failure: user does not exist' on the one in the PR..

(Apologies to -doc and GNATS for getting this message twice)

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
What would this sentence be like if pi were 3?

----- Forwarded message from Peter Pentchev <roam@ringlet.net> -----

Date: Thu, 7 Feb 2002 10:21:13 +0200
From: Peter Pentchev <roam@ringlet.net>
To: Stefan Farfeleder <e0026813@stud3.tuwien.ac.at>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/34668: Document '+' for -t in ktrace(1)

On Wed, Feb 06, 2002 at 08:51:58AM -0800, Stefan Farfeleder wrote:
> 
> >Number:         34668
> >Category:       docs
> >Synopsis:       Document '+' for -t in ktrace(1)
> >Originator:     Stefan Farfeleder
> 
> >Description:
> The -t option takes a string of characters, of which '+' wasn't documented    till now. Wording taken from NetBSD ktrace(1).
> 
> Additional problem: kdump(1) refers to ktrace(1) for information about -t, but while ktrace defaults to DEF_POINTS (-t +), kdump has ALL_POINTS (-t +w) when no -t option is given.
> >How-To-Repeat:
> 
> >Fix:
> --- ktrace.1.orig       Wed Feb  6 16:05:12 2002
> +++ ktrace.1    Wed Feb  6 16:40:44 2002
> @@ -119,6 +119,8 @@
>  userland traces
>  .It Cm w
>  context switches
> +.It Cm +
> +trace the default set of trace points (c, n, i, s, u)
>  .El
>  .It Ar command
>  Execute

Would it not be better to mark those up as Cm's, as in
the attached patch?
G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
This sentence contains exactly threee erors.

Index: src/usr.bin/ktrace/ktrace.1
===================================================================
RCS file: /home/ncvs/src/usr.bin/ktrace/ktrace.1,v
retrieving revision 1.13
diff -u -r1.13 ktrace.1
--- src/usr.bin/ktrace/ktrace.1	15 Jul 2001 08:01:20 -0000	1.13
+++ src/usr.bin/ktrace/ktrace.1	7 Feb 2002 08:19:48 -0000
@@ -119,6 +119,13 @@
 userland traces
 .It Cm w
 context switches
+.It Cm +
+trace the default set of trace points -
+.Cm c ,
+.Cm n ,
+.Cm i ,
+.Cm s ,
+.Cm u
 .El
 .It Ar command
 Execute



----- End forwarded message -----
Comment 3 Peter Pentchev 2002-02-07 08:37:01 UTC
The second e-mail address that I tried bounces too.

Still, I think this PR should be addressed, regardless of the fact
that the originator's e-mail address bounces :)

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
This sentence would be seven words long if it were six words shorter.
Comment 4 Stefan Farfeleder 2002-02-07 17:14:51 UTC
Peter Pentchev wrote:
>Would it not be better to mark those up as Cm's, as in the attached
>patch?

That's ok with me. Sorry about the bouncing mails, the address is
correct, but the server at the university was down for some reason.
Everything should work again by now :-)

Stefan
Comment 5 Dima Dorfman 2002-02-10 07:32:51 UTC
Peter Pentchev <roam@ringlet.net> wrote:
>  --IrhDeMKUP4DT/M7F
>  Content-Type: text/plain; charset=us-ascii
>  Content-Disposition: inline
>  Content-Transfer-Encoding: quoted-printable

Ugh.  GNATS does a very good job of making MIME unreadable.

>  Would it not be better to mark those up as Cm's, as in
>  the attached patch?

Yes, but not quite; I think using a single Cm would be even better, as
in the following.

P.S.  Peter, please commit this in a few days if nobody objects and I
don't do it myself.

Index: ktrace.1
===================================================================
RCS file: /ref/cvsf/src/usr.bin/ktrace/ktrace.1,v
retrieving revision 1.13
diff -u -r1.13 ktrace.1
--- ktrace.1	15 Jul 2001 08:01:20 -0000	1.13
+++ ktrace.1	10 Feb 2002 07:28:25 -0000
@@ -119,6 +119,9 @@
 userland traces
 .It Cm w
 context switches
+.It Cm +
+trace the default set of trace points -
+.Cm c , n , i , s , u
 .El
 .It Ar command
 Execute
Comment 6 Peter Pentchev freebsd_committer freebsd_triage 2002-02-11 09:06:58 UTC
State Changed
From-To: open->closed

The fix to ktrace(1) was committed.  Thanks!