Explain the newfs naming convention
ClosedPublic
Actions

Authored by 0mp on Jan 20 2021, 10:48 AM.

Details

Reviewers

kib
emaste
imp

Group Reviewers

manpages

Summary

It might be unclear why newfs and newfs_msdos should cross-reference
each other. Add a note explaining it.

Reported by: kib

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 38656
Build 35545: arc lint + arc unit

Event Timeline

0mp created this revision.Jan 20 2021, 10:48 AM

Herald added a reviewer: manpages. · View Herald TranscriptJan 20 2021, 10:48 AM

0mp requested review of this revision.Jan 20 2021, 10:48 AM

Harbormaster completed remote builds in B36359: Diff 82612.Jan 20 2021, 10:48 AM

I am kib, for tagline purposes, not kostikbel.

sbin/newfs/newfs.8
302	I do not see much usefulness in this parenthesized text, it can be omitted without any loss.

0mp edited the summary of this revision. (Show Details)Jan 20 2021, 12:51 PM

In D28251#631762, @kib wrote:

I am kib, for tagline purposes, not kostikbel.

Ach yes, sorry about that. :)

Let me know if the change here looks good to you. Otherwise, I'll revert the cross-reference from both newfs and newfs_msdos, as I can see some elegance in this approach well. Cheers!

rpokala added a subscriber: rpokala.Jan 21 2021, 6:16 AM

rpokala added inline comments.

sbin/newfs/newfs.8

306

I think this version reads better in English:

.Sh NOTES ON THE NAMING
.Dq newfs
is a common name prefix for utilities creating filesystems, with the suffix
indicating the type of the filesystem, for instance
.Xr newfs_msdos 8 .
.Nm
is a special case which predates that convention.