git: 643758d2c260 - stable/13 - Explain the newfs naming convention

[Mateusz Piotrowski]

The branch stable/13 has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=643758d2c26058a153c191128a4f7efe7c6cf820

commit 643758d2c26058a153c191128a4f7efe7c6cf820
Author:     Mateusz Piotrowski <0mp at FreeBSD.org>
AuthorDate: 2021-01-20 10:40:20 +0000
Commit:     Mateusz Piotrowski <0mp at FreeBSD.org>
CommitDate: 2021-04-20 08:07:25 +0000

    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)
---
 sbin/newfs/newfs.8 | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

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