Differential D53827

beep: Sort usage and man page options
ClosedPublic
Actions

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

Tags

None

Referenced Files

	F175235676: D53827.id166972.diff
	Fri, Oct 9, 7:58 AM

	F175184245: D53827.id166972.diff
	Thu, Oct 8, 10:43 PM

	F175184222: D53827.id166856.diff
	Thu, Oct 8, 10:43 PM

	F175184216: D53827.id166788.diff
	Thu, Oct 8, 10:43 PM

	F175176827: D53827.diff
	Thu, Oct 8, 9:40 PM

	Unknown Object (File)
	Sat, Oct 3, 10:47 PM

	Unknown Object (File)
	Sat, Oct 3, 2:07 PM

	Unknown Object (File)
	Sat, Oct 3, 2:03 PM

Subscribers

pauamma_chezdork.com

Details

Reviewers

pauamma_chezdork.com
christos

Group Reviewers

Commits

rG8d338f99f8b1: beep: Sort usage and man page options
rG4c10ec9bd43f: beep: Sort usage and man page options
rG6bda3655b827: beep: Sort usage and man page options
rG55d98b024f25: beep: Sort usage and man page options

Summary

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

PR: 291092

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 68770
Build 65653: arc lint + arc unit

Event Timeline

jlduran created this revision.Nov 19 2025, 4:02 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptNov 19 2025, 4:02 PM

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

Harbormaster completed remote builds in B68742: Diff 166780.Nov 19 2025, 4:02 PM

jlduran added a reviewer: manpages.Nov 19 2025, 4:04 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.Nov 19 2025, 4:59 PM

Address suggestions from both Phabricator and Bugzilla.

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

Harbormaster completed remote builds in B68743: Diff 166788.Nov 19 2025, 5:55 PM

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

emaste added a reviewer: christos.Nov 19 2025, 7:39 PM

christos added inline comments.Nov 20 2025, 2:06 PM

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.Nov 20 2025, 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.

christos added inline comments.Nov 20 2025, 3:27 PM

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:

s/playback/play/
s/soundcard/sound card/

Harbormaster completed remote builds in B68770: Diff 166856.Nov 20 2025, 3:39 PM

jlduran added inline comments.Nov 20 2025, 3:40 PM

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.

christos accepted this revision.Nov 20 2025, 3:41 PM

This revision is now accepted and ready to land.Nov 20 2025, 3:41 PM

Closed by commit rG55d98b024f25: beep: Sort usage and man page options (authored by jlduran). · Explain WhyNov 22 2025, 5:32 PM

This revision was automatically updated to reflect the committed changes.

jlduran added a commit: rG55d98b024f25: beep: Sort usage and man page options.

jlduran added a commit: rG6bda3655b827: beep: Sort usage and man page options.Nov 29 2025, 12:36 AM

jlduran added a commit: rG4c10ec9bd43f: beep: Sort usage and man page options.

jlduran added a commit: rG8d338f99f8b1: beep: Sort usage and man page options.

Revision Contents
Changeset List

Path

Size

usr.bin/

beep/

55 lines

19 lines

Diff 166856

usr.bin/beep/beep.1

Loading...

usr.bin/beep/beep.c

Loading...