- Download Diff

Summary:

12784 Fix errors in plockstat man page

Review Request #2564 — Created May 23, 2020 and submitted May 26, 2020, 8:32 a.m.

Information
Owner:	nanxiao
Repository:	illumos-gate
Branch:
Bugs:	12784
Depends On:
Reviewers
Groups:	general
People:

Description

(1)

Refer to the for more information about DTrace security features.

"Dynamic Tracing Guide" is omitted.

(2)

Print the Dtrace commands used to gather the data.

It should be "DTrace", not "Dtrace".

Testing Done

Issues

1
0
1
0
All Issues: 2

Description	From	Last Updated
Please do not exceed the 80 character in one line limit. Move some of the last words to the next ...	domag02	May 23, 2020, 10:12 p.m.
Perhaps "Refer to..." should begin a new paragraph.	seeemef@mac.com	May 23, 2020, 10:21 p.m.

usr/src/man/man1m/plockstat.1m (Diff revision 1)

Show all issues

Please do not exceed the 80 character in one line limit. Move some of the last words to the next line, for example:
...

with \fBplockstat\fR. Refer to the \fIDynamic Tracing Guide\fR for more
information about DTrace security features.

...

nanxiao May 23, 2020, 10:12 p.m.

Please ignore Revision 2 and check Revision 3, thanks very much!

Change Summary:

Wrap line to not exceed 80 characters.

Diff:

Revision 2 (+3 -10)

Show changes

usr/src/man/man1m/plockstat.1m

Diff:

Revision 3 (+4 -11)

Show changes

usr/src/man/man1m/plockstat.1m

Fix it!

usr/src/man/man1m/plockstat.1m (Diff revision 3)

Show all issues

Perhaps "Refer to..." should begin a new paragraph.

nanxiao May 23, 2020, 11:23 p.m.

Users must have the dtrace_proc privilege and have permission to observe a particular process with plockstat. Refer to the Dynamic Tracing Guide for more information about DTrace security features.

IMHO, "Refer to ..." is associated with previous "Users must have the dtrace_proc privilege and have permission to ...", so maybe they should be in the same paragraph?

domag02 May 24, 2020, 5:35 p.m.

I think it's okay to have the phrase "Refer to..." in the same paragraph.
Just like in lockstat(1M):

...
default. The system administrator can permit other users to use \fBlockstat\fR
by granting them additional DTrace privileges. Refer to the \fIDynamic
Tracing Guide\fR for more information about DTrace security features.
...

seeemef@mac.com May 25, 2020, 2:54 p.m.

OK I see your points. In this man page, it had read to me as a general referral instead of tying to the paragraph's specific contents.

Ship it!

```
Ship It!
```

Ship it!

You have a pending review.

Review Board 3.0.18

12784 Fix errors in plockstat man page

Change Summary:

Diff:

Diff:

Status: Closed (submitted)