Explain the newfs naming convention

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

This is a follow-up to 74bd207697.

Reported by:	kib
Reviewed by:    imp, kib, rpokala
MFC after:	3 days
This commit is contained in:
Mateusz Piotrowski 2021-01-20 11:40:20 +01:00
parent c4207d867c
commit 5b9b65e92f

View File

@ -28,7 +28,7 @@
.\" @(#)newfs.8 8.6 (Berkeley) 5/3/95
.\" $FreeBSD$
.\"
.Dd January 7, 2021
.Dd April 17, 2021
.Dt NEWFS 8
.Os
.Sh NAME
@ -291,6 +291,14 @@ to find the alternate superblocks if the standard superblock is lost.
.It Fl S Ar sector-size
The size of a sector in bytes (almost never anything but 512).
.El
.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 .
The
.Nm
utility is a special case which predates that convention.
.Sh EXAMPLES
.Dl newfs /dev/ada3s1a
.Pp