Bug 282867

Summary: ffs(7) not advertised enough.
Product: Documentation Reporter: David Gilbert <dave>
Component: Manual PagesAssignee: Robert Clausecker <fuz>
Status: Closed FIXED    
Severity: Affects Only Me CC: doc, fuz, jamie, mhorne, ziaee
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
Diff against -CURRENT. none

Description David Gilbert 2024-11-19 19:59:16 UTC 
So... I was looking for information regarding ffs and trim --- specifically, I had just dd'd a disk onto a mirror and wondered if ffs had a method like zfs trim.

Anyways... manpages like newfs, mount, makefs ... etc.  Someone needs to make a list.  They didn't list ffs(7) as a SEE ALSO.  And "man ffs" grabs ffs(3) ... some library fucntions regarding bits.

So... I humbly submit that the fact that ffs(7) is missing in many SEE ALSO sections is a bug.
Comment 1 David Gilbert 2024-11-23 21:39:24 UTC 
Created attachment 255418 [details]
Diff against -CURRENT.

I have a couple of ways to make this argument.  One is that the things referenced by ffs(7) itself should reference back.  Another is that we have specific commands for fsck_ffs (which does reference) but not for mount, newfs or tunefs (don't reference).

Anyways, this is my ask: adding ffs(7) as a see-also for ffsinfo(!?!), mount,  and newfs.
Comment 2 Mitchell Horne freebsd_committer freebsd_triage 2024-11-25 16:01:54 UTC 
In -CURRENT, ffs(7) and other filesystem pages have been moved to section four: ffs(4).
Comment 3 David Gilbert 2024-11-25 16:34:25 UTC 
Seems like this should apply against 14 and 13 and a slight change should be made for -Current?
Comment 4 Robert Clausecker freebsd_committer freebsd_triage 2024-11-25 20:53:55 UTC 
I'll see that I can get this committed.

What name and email address would you like to be used for the commit?  Just

    dave <dave@daveg.ca>

or do you want your full name?  If yes, please specify.
Comment 5 David Gilbert 2024-11-25 21:10:01 UTC 
Hrm.  Just merged accounts.  I corrected the name field.
Comment 6 commit-hook freebsd_committer freebsd_triage 2024-11-25 22:02:15 UTC 
A commit in branch main references this bug:

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

commit 3a212cc66ad1b5d6c1dc97eb07143e919a123491
Author:     David Gilbert <dave@daveg.ca>
AuthorDate: 2024-11-25 21:57:20 +0000
Commit:     Robert Clausecker <fuz@FreeBSD.org>
CommitDate: 2024-11-25 21:57:20 +0000

    sbin/{ffsinfo,mount,newfs}: reference ffs(4) in man pages

    PR:             282867
    MFC:            stable/14
    Approved by:    mhorne (via IRC)

 sbin/ffsinfo/ffsinfo.8 | 3 ++-
 sbin/mount/mount.8     | 3 ++-
 sbin/newfs/newfs.8     | 3 ++-
 3 files changed, 6 insertions(+), 3 deletions(-)
Comment 7 commit-hook freebsd_committer freebsd_triage 2024-11-25 22:06:17 UTC 
A commit in branch stable/14 references this bug:

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

commit 435a5f94fbc09959c0a4e48b1e81a50fcfd45673
Author:     David Gilbert <dave@daveg.ca>
AuthorDate: 2024-11-25 21:57:20 +0000
Commit:     Robert Clausecker <fuz@FreeBSD.org>
CommitDate: 2024-11-25 22:05:11 +0000

    sbin/{ffsinfo,mount,newfs}: reference ffs(4) in man pages

    With some copy-editing to account for the man page being in
    section 7 on stable/14.

    PR:             282867
    MFC:            stable/14
    Approved by:    mhorne (via IRC)

    (cherry picked from commit 3a212cc66ad1b5d6c1dc97eb07143e919a123491)

 sbin/ffsinfo/ffsinfo.8 | 3 ++-
 sbin/mount/mount.8     | 3 ++-
 sbin/newfs/newfs.8     | 3 ++-
 3 files changed, 6 insertions(+), 3 deletions(-)
Comment 8 Robert Clausecker freebsd_committer freebsd_triage 2024-11-25 22:06:40 UTC 
Thank you for your contribution.
Comment 9 Jamie Landeg-Jones 2024-11-26 04:28:57 UTC 
(In reply to David Gilbert from comment #5)

How do you do that? I have at least one other account on here, as they were primed with email addresses from the previous bug tracker, and I changed primary address a few times throughout its lifetime.

Cheers
Comment 10 David Gilbert 2024-11-26 05:25:21 UTC 
(In reply to Jamie Landeg-Jones from comment #9)

getting my accounts merged was an email to bugmeister@

Changing my long name was under preferences in the interface.
Comment 11 Alexander Ziaee freebsd_triage 2024-11-26 18:02:24 UTC 
I considered the same thing for file allocation table file system tooling and have had a patch open for one month about it. Should I file a new bug to encourage it move?

https://github.com/freebsd/freebsd-src/pull/1501