API tools faq
paste
Guest User

illumos man page bugs

a guest
Feb 23rd, 2026
38
0
102 days
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 8.68 KB | Source Code | 0 0
raw download clone embed print report
  1. Our man page changes for this quarter are at:
  2. https://gist.github.com/alanc/cfbaa19eb1ee04afe996da97f121fe7e
  3.  
  4. My big man page project for the quarter was a cleanup pass across the
  5. section 4M man pages. Changes from those included:
  6.  
  7. - Formatting, spelling, grammar, wording, and typo fixes across many pages
  8. - Add History sections to many pages
  9. - Add Attributes tables in a few pages
  10. - Standardize on <> being included in the bold text for header references
  11. - Standardize markup for I_PUSH ioctl lines in Synopsis sections
  12. - Remove "PCI-based systems" from Architecture tables, since that is all
  13. we support in Solaris 11.4 (as opposed to Sbus-based systems supported
  14. before the sun4u EOF).
  15. - Add missing x86 modules to the Files section where needed
  16.  
  17. Fixes I see that apply to your pages as well include:
  18.  
  19. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/kbd.1#L59
  20. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/kbd.1#L129
  21. - Even on the illumos distros that support SPARC, I don't think you support
  22. any hardware old enough to have a keyboard with a key labeled "L1" instead
  23. of "Stop"
  24.  
  25. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/loadkeys.1#L26
  26. - "," is not part of the filename, should be after \fR, not before it
  27.  
  28. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/loadkeys.1#L27
  29. - "dd" refers to the replaceable value here, not the command, so should be
  30. italic, not bold
  31.  
  32. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/loadkeys.1#L30-L32
  33. - DIP switches to set layouts are only on Type 5 & older Sun keyboards
  34.  
  35. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man1/loadkeys.1#L42
  36. - missing the type_tt directory from the path that was shown above
  37.  
  38. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man2/mount.2
  39. - when mounting ZFS filesystems, the spec argument points to a dataset name,
  40. not a device file. (Other values may be used for pseudo-filesystems that
  41. aren't stored on disk, like procfs, ctfs, etc.)
  42.  
  43. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man3c/qsort.3c#L129
  44. - the (void *) cast on the first argument is unnecessary
  45.  
  46. kb(4M)
  47. - where you seem to have removed this in the SPARC EOL, I moved it to kbio(4I)
  48. and dropped a bunch of obsolete bits that only applied to old SPARC keyboards
  49. and started delivering it on x86 as well
  50.  
  51. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/bufmod.4m#L23
  52. - "-based" should not be bold
  53.  
  54. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/bufmod.4m#L23
  55. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/bufmod.4m#L191
  56. - "uint_t" should be a type (bold) not a parameter name (italic)
  57.  
  58. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/bufmod.4m#L203
  59. - "description of effect" seems like it should have a "the" before "effect"
  60.  
  61. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/bufmod.4m#L287-L291
  62. - the SBIOCSFLAGS ioctl was added in Solaris 2.1, so the "older versions"
  63. mentioned here were Solaris 2.0 and earlier, not something you really need
  64. to consider when writing code in the 21st century
  65.  
  66. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ldterm.4m#L32-L33
  67. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ldterm.4m#L39
  68. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ldterm.4m#L174
  69. - "The" and "module" should not be bold
  70.  
  71. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ldterm.4m#L72
  72. - ")," should not be bold
  73.  
  74. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pfmod.4m
  75. - doesn't document Pf_ext_packetfilt added in PSARC/1998/429 as part of the
  76. IPv6 support projects
  77.  
  78. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pfmod.4m#L17
  79. - "IPUSH" should be "I_PUSH"
  80.  
  81. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pfmod.4m#L100
  82. - "ushort_t" should be bold, the following "s" should not
  83.  
  84. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pfmod.4m#L103-L125
  85. - the "_" should be replaced by italics to mark as replaceable text
  86.  
  87. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pfmod.4m#L250-L255
  88. - See Also is missing streamio(4I)
  89.  
  90. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/pipemod.4m#L26
  91. - "all message" should be "all messages"
  92.  
  93. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/timod.4m#L13
  94. - missing <sys/timod.h>
  95.  
  96. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/timod.4m#L50-L53
  97. - "strioctl" should be "my_strioctl" when referring to the variable name
  98. instead of the type name
  99.  
  100. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/timod.4m#L52
  101. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/timod.4m#L60-L61
  102. - "size" should be italic (parameter name) instead of bold (command name)
  103.  
  104. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/timod.4m#L171
  105. - errno values are listed in Intro(2), not Intro(3)
  106.  
  107. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/tirdwr.4m#L18
  108. - there is no Section 3N - you have 3NSL, we merged into 3C
  109.  
  110. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/tirdwr.4m#L21-L22
  111. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/tirdwr.4m#L65
  112. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/tirdwr.4m#L94
  113. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/tirdwr.4m#L118-L119
  114. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L26-L27
  115. - missing "()" after system call names (getmsg, putmsg, read, write, ioctl)
  116.  
  117. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L26-L27
  118. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L73
  119. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L143
  120. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L305-L306
  121. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L451
  122. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L461
  123. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L570-L571
  124. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L658
  125. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/ttcompat.4m#L672
  126. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L48
  127. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L133-L136
  128. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L160-L167
  129. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L187
  130. - symbols/macros should be bold (TIOCGETP, TIOCSETP, VERASE, VKILL, INPCK, etc.)
  131.  
  132. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usb_ah.4m#L14
  133. - "button" should be "buttons"
  134.  
  135. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usb_ah.4m#L46
  136. - missing space between "x86" and "64-bit"
  137.  
  138. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbkbm.4m#L37
  139. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbkbm.4m#L100
  140. - defining with references to kb(4M) doesn't help if kb(4M) isn't delivered
  141. (see above note about kb(4M))
  142.  
  143. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbkbm.4m#L90
  144. - missing "." at end of sentences
  145.  
  146. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbkbm.4m#L141-L145
  147. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L259-L263
  148. - this should be 64-bit now, with "/amd64" in the path
  149.  
  150. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L76
  151. - "too" should be "to"
  152.  
  153. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/usbms.4m#L187
  154. - "'VUIDGWHEEL INFO'" should be "VUIDGWHEELINFO"
  155.  
  156. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/vuidmice.4m#L28-L48
  157. - the third argument in each call should be a quoted string
  158.  
  159. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/vuidmice.4m#L81
  160. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/vuidmice.4m#L84
  161. - if statements should not have ";" after ")"
  162.  
  163. https://github.com/illumos/illumos-gate/blob/master/usr/src/man/man4m/vuidmice.4m#L263
  164. - "/" should be after space, not before (i.e. "/dev/msm")
  165.  
Advertisement
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!