aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMateusz Piotrowski <0mp@FreeBSD.org>2021-01-20 10:40:20 +0000
committerMateusz Piotrowski <0mp@FreeBSD.org>2021-04-20 08:07:25 +0000
commit643758d2c26058a153c191128a4f7efe7c6cf820 (patch)
treedaaeb8dacb2583a4bf0602c4e38f059b17f5ba8f
parentb94b7f317594deea9baf4e0fa7036f14adf00954 (diff)
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 74bd20769706041108a573601cf0b61c755bdc56. Reported by: kib Reviewed by: imp, kib, rpokala MFC after: 3 days (cherry picked from commit 5b9b65e92fb40703038cbcf61feb4616c42e0b6e)
-rw-r--r--sbin/newfs/newfs.810
1 files changed, 9 insertions, 1 deletions
diff --git a/sbin/newfs/newfs.8 b/sbin/newfs/newfs.8
index 0cc1d7ce12cf..5213e4109363 100644
--- a/sbin/newfs/newfs.8
+++ b/sbin/newfs/newfs.8
@@ -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