beep: Sort usage and man page options
AcceptedPublic
Actions

Authored by jlduran on Wed, Nov 19, 4:02 PM.

Details

Reviewers

pauamma_gundo.com
christos

Group Reviewers

manpages

Summary

Sort usage and man page options, mention possible minimum and maximum
values, and fix punctuation marks.

PR: 291092

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 68770
Build 65653: arc lint + arc unit

jlduran requested review of this revision.Wed, Nov 19, 4:02 PM

Manual page changes look OK to me with this nit fixed.

usr.bin/beep/beep.1
57	Consistent naming with usage().

This revision is now accepted and ready to land.Wed, Nov 19, 4:59 PM

Address suggestions from both Phabricator and Bugzilla.

This revision now requires review to proceed.Wed, Nov 19, 5:55 PM

Thank you!
If there are no further suggestions, I'll commit over the weekend.

usr.bin/beep/beep.1
71–72
usr.bin/beep/beep.c
137–150	Isn't this redundant since we have the same info in the man page?

jlduran marked an inline comment as done.Thu, Nov 20, 3:17 PM

jlduran added inline comments.

usr.bin/beep/beep.1
71–72	Should we change the description as well? Given "playback" has a slightly different meaning?
usr.bin/beep/beep.c
137–150	Usually the usage is a compact version of the SYNOPSIS/DESCRIPTION of the man page. It is kept redundant in case a user decides not to install man pages.

usr.bin/beep/beep.1
71–72	Yeap.
usr.bin/beep/beep.c
137–150	I mentioned this because I don't think we do this a lot.

Address suggestions:

usr.bin/beep/beep.c
137–150	Given it is already there, I don't think it is appropriate to remove it, or at least not in this commit. A personal opinion is that we should strive to have both, as described in https://en.wikipedia.org/wiki/Usage_message.