12784 Fix errors in plockstat man page

Review Request #2564 — Created May 23, 2020 and submitted

nanxiao
illumos-gate
12784
general

(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".



  • 1
  • 0
  • 1
  • 0
  • 2
Description From Last Updated
Perhaps "Refer to..." should begin a new paragraph. seeemef@mac.com seeemef@mac.com
domag02
  1. 
      
  2. usr/src/man/man1m/plockstat.1m (Diff revision 1)
     
     

    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.
    

    ...

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

  3. 
      
nanxiao
nanxiao
seeemef@mac.com
  1. 
      
  2. usr/src/man/man1m/plockstat.1m (Diff revision 3)
     
     

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

    1. 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?

    2. 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.
      ...
      
    3. 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.

  3. 
      
domag02
  1. Ship It!
  2. 
      
seeemef@mac.com
  1. 
      
  2. 
      
nanxiao
Review request changed

Status: Closed (submitted)

Loading...