12669 Add omitted word in vmstat man page

Review Request #2543 — Created May 1, 2020 and submitted

nanxiao
illumos-gate
12669
general

Add omitted word in vmstat man page

# man -M usr/src/man/ vmstat > /tmp/after
# man vmstat > /tmp/prev
# diff /tmp/prev /tmp/after
41c41
<        See  for device naming conventions for disks.
---
>        See disks(1M) for device naming conventions for disks.
301c301
<        date(1), sar(1), iostat(1M), mpstat(1M), sar(1M), time(2),
---
>        date(1), sar(1), disks(1M), iostat(1M), mpstat(1M), sar(1M), time(2),
311c311
<                                 April 14, 2015                      VMSTAT(1M)
---
>                                   May 1, 2020                       VMSTAT(1M)
  • 0
  • 0
  • 2
  • 0
  • 2
Description From Last Updated
marcel
  1. 
      
  2. usr/src/man/man1m/vmstat.1m (Diff revision 1)
     
     

    In cases like this there is usually missing link to some external document.

    https://docs.oracle.com/cd/E19455-01/806-0625/6j9vfim2k/index.html

    1. in our case, it may be useful to have reference to disks(1M).

    2. So which one should I use? disks(1M) or Solaris Transition Guide? Thanks!

    3. We are not Solaris, even as we do have roots from Solaris.

    4. disks(1M) is in illumos and we can control the contents, so that seems a better reference than the old (now Oracle) Solaris Transition Guide.

    5. Also if we're referencing a manual page up there in the text, make sure to add an appropriate cross reference to SEE ALSO as well! Thanks.

    6. Yes, please use disks(1M) as suggested by Josh.

    7. ... and Toomas.

    8. Updated, please check, thanks!

  3. 
      
nanxiao
tsoome
  1. Seems OK, please make sure git pbchk is clean.

  2. 
      
andy_js
  1. Ship It!
  2. 
      
marcel
  1. Ship It!
  2. usr/src/man/man1m/vmstat.1m (Diff revision 2)
     
     

    Please update this line too.

  3. 
      
nanxiao
marcel
  1. Ship It!
  2. 
      
nanxiao
Review request changed

Status: Closed (submitted)

Loading...