Differential D53827

beep: Sort usage and man page options
ClosedPublic
Actions

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

Tags

None

Referenced Files

	Unknown Object (File)
	Wed, Dec 10, 7:24 PM

	Unknown Object (File)
	Tue, Dec 2, 4:03 PM

	Unknown Object (File)
	Tue, Dec 2, 4:03 PM

	Unknown Object (File)
	Tue, Dec 2, 4:03 PM

	Unknown Object (File)
	Sun, Nov 30, 1:20 PM

	Unknown Object (File)
	Sat, Nov 29, 12:27 PM

	Unknown Object (File)
	Thu, Nov 27, 11:42 PM

	Unknown Object (File)
	Wed, Nov 26, 7:36 AM

View All 31 Files

Subscribers

pauamma_gundo.com

Details

Reviewers

pauamma_gundo.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 Not Applicable

Unit

Tests Not Applicable

Event Timeline

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

Herald added subscribers: ziaee, imp. · View Herald TranscriptWed, Nov 19, 4:02 PM

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

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

jlduran added a reviewer: manpages.Wed, Nov 19, 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.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

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

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

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

christos added inline comments.Thu, Nov 20, 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.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.

christos added inline comments.Thu, Nov 20, 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.Thu, Nov 20, 3:39 PM

jlduran added inline comments.Thu, Nov 20, 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.Thu, Nov 20, 3:41 PM

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

Closed by commit rG55d98b024f25: beep: Sort usage and man page options (authored by jlduran). · Explain WhySat, Nov 22, 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.Sat, Nov 29, 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 166972

usr.bin/beep/beep.1

Loading...

usr.bin/beep/beep.c

Loading...