Bug 293423 - ffs(4): should mention UFS2 snapshots, add symlink, etc.
Summary: ffs(4): should mention UFS2 snapshots, add symlink, etc.
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Alexander Ziaee
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2026-02-24 12:17 UTC by Bruce M Simpson
Modified: 2026-04-10 18:32 UTC (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Bruce M Simpson freebsd_committer freebsd_triage 2026-02-24 12:17:18 UTC 
Whilst the mount(8) man page does describe snapshots, there is no mention of ufs2 snapshot specifics, and no mention of it in the now-obscurely-named ffs(4) manual page. That is rather confusing, frankly. There's no "ufs" or "ufs2" man page symlink for ffs(4) which would surely make this information slightly easier to find in an "apropos" / "man -k" search.

Noticed when turning up TRIM for Hyper-V guests.
Comment 1 Alexander Ziaee freebsd_committer freebsd_triage 2026-02-24 13:28:39 UTC 
The mlink was easy, so I committed that just now. I'll write up something nice to integrate into the page about snapshots and send it to Kirk for review.
Comment 2 commit-hook freebsd_committer freebsd_triage 2026-02-24 13:28:45 UTC 
A commit in branch main references this bug:

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

commit f0b8355db6ba57a0849c41722e0a09f312d9eef5
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-02-24 13:24:16 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-02-24 13:26:20 +0000

    ffs.4: Mlink to ufs.4

    PR:             293423
    MFC after:      3 days
    Requested by:   bms

 share/man/man4/Makefile | 1 +
 share/man/man4/ffs.4    | 5 +++--
 2 files changed, 4 insertions(+), 2 deletions(-)
Comment 3 commit-hook freebsd_committer freebsd_triage 2026-04-10 18:32:24 UTC 
A commit in branch stable/15 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=482e77ad3687fc4628a78316b4ce4265ce3477ff

commit 482e77ad3687fc4628a78316b4ce4265ce3477ff
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-02-24 13:24:16 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-04-10 18:28:00 +0000

    ffs.4: Mlink to ufs.4

    PR:             293423
    MFC after:      3 days
    Requested by:   bms

    (cherry picked from commit f0b8355db6ba57a0849c41722e0a09f312d9eef5)

 share/man/man4/Makefile | 1 +
 share/man/man4/ffs.4    | 5 +++--
 2 files changed, 4 insertions(+), 2 deletions(-)