sh.1: Renew description of case
ClosedPublic
Actions

Authored by ziaee on Wed, Sep 9, 6:55 AM.

Details

Reviewers

bapt
des
jilles
pstef
temcbun_gmail.com
bcr

Group Reviewers

manpages

Commits

rG35973eceff09: sh.1: Renew description of case

Summary

Case explaination is quite out of date.
I studied what openbsd and netbsd are doing, and try to fix it.

show the optional left parenthesis and optional list
explain there can be a space or not after the pattern
use markup
split the paragraphs
remove totally unnecessary actually (akshually)
import the exit status line from netbsd

While here, remove the '-' from the beginning of this document.

PR: 298329
Fixes: c9afaa63894e ("Add case statement fallthrough")
Fixes: f7a9b7fe3a8d ("Allow a left parenthesis before patterns in case blocks")
Fixes: e00e16ad7f86 ("Allow empty case/esac statements")
MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 76773
Build 73656: arc lint + arc unit

Event Timeline

ziaee created this revision.Wed, Sep 9, 6:55 AM

Herald added a subscriber: imp. · View Herald TranscriptWed, Sep 9, 6:55 AM

ziaee requested review of this revision.Wed, Sep 9, 6:55 AM

Harbormaster completed remote builds in B76682: Diff 186241.Wed, Sep 9, 6:55 AM

OK for the manpage, looks good!

This revision is now accepted and ready to land.Wed, Sep 9, 1:28 PM

Looks good!

One note: POSIX also says: After the first match, no more patterns in the case statement shall be expanded .... It may sound obvious, but perhaps we should mention it here as well?

In D59518#1366090, @temcbun_gmail.com wrote:

Looks good!

One note: POSIX also says: After the first match, no more patterns in the case statement shall be expanded .... It may sound obvious, but perhaps we should mention it here as well?

The words "in turn" are probably intended to describe this, but may benefit from a few more words.

bin/sh/sh.1
1095–1096	Slightly unfortunate that the document repeats itself now but only for the close parenthesis.
1097	Hmm, I'm not sure we should be describing all optional white space. As noted near the start, the man page isn't intended to be a complete description. The optional open parenthesis seems useful to include in the syntax as done here (but please do not add anything more about it).
1123–1129	Pre-existing: it's a bit unfortunate to introduce the word "fallthrough" here, since it might be unclear. The control operator .Ql Cm ;& is specified by POSIX, but in practice is not entirely portable. may be better.