Page MenuHomeFreeBSD

Improve the binmiscctl manual page
ClosedPublic

Authored by 0mp on May 27 2018, 2:43 PM.
Referenced Files
Unknown Object (File)
Mar 16 2024, 1:59 AM
Unknown Object (File)
Mar 16 2024, 1:59 AM
Unknown Object (File)
Mar 16 2024, 1:59 AM
Unknown Object (File)
Mar 12 2024, 6:11 AM
Unknown Object (File)
Mar 8 2024, 5:04 AM
Unknown Object (File)
Jan 6 2024, 10:59 AM
Unknown Object (File)
Jan 4 2024, 3:49 AM
Unknown Object (File)
Dec 20 2023, 4:45 AM

Details

Summary

Changes:

  • Ues Fl - instead of `Cm -- for long options.
  • Sort options alphabetically.
  • Pet mandoc -Tlint.
  • Clean up the description of the --interpreter option.
  • Clean up the description of the first example in the examples section.
  • Use .Bd -literal -offset indent for all example code blocks for consistency.
  • Use Nm instead of Cm binmiscctl.
  • Indent all examples for consistency.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

0mp added a subscriber: mat.

Reupload with arcanist as suggested by @mat on multiple occasions.

I am clueless about mdoc, so I am going to approve this, so that you can commit it when someone from manpages says it is ok.

allanjude added a subscriber: allanjude.
allanjude added inline comments.
usr.sbin/binmiscctl/binmiscctl.8
77 โ†—(On Diff #45518)

instead of literally the word indent, you might consider using the name of the longest option. You'd have to see how it looks and decide if it makes sense

0mp marked an inline comment as done.Jul 20 2018, 10:45 PM
0mp added inline comments.
usr.sbin/binmiscctl/binmiscctl.8
77 โ†—(On Diff #45518)

I've tried other values. indent is defined in mdoc(7) as the width of a standard indentation (six constant width characters) so I guess I would stick to the standard here. Especially, that the longest option is add: add name --interpreter path --magic magic --size size [--mask mask] [--offset offset] [--set-enabled]. ๐Ÿ˜„

This revision was not accepted when it landed; it landed in state Needs Review.Jul 20 2018, 10:50 PM
Closed by commit rS336567: Improve the binmiscctl manual page (authored by 0mp). ยท Explain Why
This revision was automatically updated to reflect the committed changes.
0mp marked an inline comment as done.