Bug 283881 - Fix doc fallout after creation of ports/filesystems
Summary: Fix doc fallout after creation of ports/filesystems
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-ports-bugs (Nobody)
URL: https://github.com/freebsd/freebsd-po...
Keywords: tracking
Depends on:
Blocks:
 
Reported: 2025-01-06 07:03 UTC by Graham Perrin
Modified: 2025-03-02 11:46 UTC (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2025-01-06 07:03:04 UTC
For one of the one hundred and forty-two: 

grahamperrin:~ % rg --count --sort path sysutils\/openzfs /usr/doc
/usr/doc/documentation/content/en/books/handbook/zfs/_index.adoc:1
/usr/doc/documentation/content/en/books/handbook/zfs/_index.po:1
grahamperrin:~ % 

So, for example, <https://docs.freebsd.org/en/books/handbook/zfs/#zfs-zfs-compression-zstd> leads to <https://cgit.freebsd.org/ports/tree/sysutils/openzfs/> with a red alert: 

> Path not found

– and we must not assume that a newcomer to the FreeBSD Handbook will be familiar with website navigation in cgit, and so on …
Comment 1 Graham Perrin 2025-01-06 07:11:44 UTC
Comment 0 was a documentation/ example, so, this is Documentation (in Bugzilla), however the scope is broader. 

website/ breakages include: 

- FreeBSD Status Report Third Quarter 2024, where 
  <https://www.freebsd.org/status/report-2024-07-2024-09/#_userspace_ufs_driver_fuse_ufs> 
  leads to a red alert (not found) for 
  <https://cgit.freebsd.org/ports/tree/sysutils/fusefs-ufs/>. 

I found that example at the foot of results from 
rg --sort path sysutils\/ /usr/doc/website/content/en
Comment 2 Graham Perrin 2025-01-06 07:25:41 UTC
Re: comment 0

> … we must not assume that a newcomer to the FreeBSD Handbook will be 
> familiar with website navigation in cgit, and so on …

For reference only, from bug 267798 (closed, not fixed): 

> … It makes no sense, many people can't read the source code 
> or the port doesn't have a pkg-descr, only a makefile. The link to 
> freshports.org is more helpful …
Comment 3 Alexander Ziaee freebsd_committer freebsd_triage 2025-01-09 22:37:01 UTC
A new filesystems category was created in the ports tree, with 142 filesystem related ports moved to there, some of them renamed [0], creating a lot of fallout in the documentation.

Graham proposed a fix for one of the cross references in the manpages here [1].

Graham, are you willing to do the rest of them in the manpage or should I just do it? I'd prefer fixing the manpage due to this commit to be one change and before users begin complaining.

Portmgr, I really like this change but please consider notifying docs@ in the future before this type of change. I think this creates a fair bit of work for us and docs doesn't have a lot of manpower. Thank you for your consideration.

[0]: https://cgit.freebsd.org/ports/commit/?id=6e2da9672f79f44048d597f0f61e4646cdeade9d
[1]: https://github.com/freebsd/freebsd-src/pull/1562
Comment 4 Graham Perrin 2025-01-12 03:13:21 UTC
Re: comment 2

>> … freshports.org is more helpful …

See also: <https://github.com/FreshPorts/freshports/issues/614>

> Freshports should suggest alternatives when accessing nonexistant port 
> · Issue #614 · FreshPorts/freshports

– thanks to fuz@
Comment 5 commit-hook freebsd_committer freebsd_triage 2025-01-27 20:04:09 UTC
A commit in branch main references this bug:

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

commit 066ef2aec187ae93a9df01d25fa8e47d67ff972b
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2025-01-27 19:59:17 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-01-27 20:03:10 +0000

    ports/filesystems: Fix fallout

    A new filesystems category was created in the ports tree, with 142
    filesystem related ports moved to there, some of them renamed.
    Update all references in the src tree to the new locations.

    PR:             283881
    Fixes:          ports:6e2da9672f79f44 (filesystems: add new category)
    MFC after:      1 month
    Reviewed by:    fuz, mhorne, bapt
    Accepted by:    mhorne (mentor)
    Differential Revision:  https://reviews.freebsd.org/D48406

 release/powerpc/generate-hfs.sh          | 2 +-
 share/man/man4/ccd.4                     | 2 +-
 share/man/man4/smbfs.4                   | 2 +-
 stand/powerpc/boot1.chrp/generate-hfs.sh | 2 +-
 tools/test/stress2/misc/ext2fs.sh        | 2 +-
 tools/test/stress2/misc/ext2fs2.sh       | 2 +-
 tools/test/stress2/misc/ext2fs3.sh       | 2 +-
 tools/test/stress2/misc/ext3fs.sh        | 2 +-
 tools/test/stress2/misc/ext4fs.sh        | 2 +-
 usr.sbin/autofs/autofs/special_media     | 4 ++--
 10 files changed, 11 insertions(+), 11 deletions(-)
Comment 6 Mark Linimon freebsd_committer freebsd_triage 2025-02-14 16:49:08 UTC
^Triage: assign to committer.

Is there anything else needed for this PR?
Comment 7 Alexander Ziaee freebsd_triage 2025-02-14 17:09:06 UTC
There's still a ton of fallout in the doc tree, I was happy to do it in src but I need a more efficient technique if I'm going to be able to do it in doc tree.
Comment 8 commit-hook freebsd_committer freebsd_triage 2025-02-27 01:19:50 UTC
A commit in branch stable/14 references this bug:

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

commit cf522ceef8fa404dc1df865fb19f9a40e34e8c56
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2025-01-27 19:59:17 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2025-02-27 01:14:37 +0000

    ports/filesystems: Fix fallout

    A new filesystems category was created in the ports tree, with 142
    filesystem related ports moved to there, some of them renamed.
    Update all references in the src tree to the new locations.

    PR:             283881
    Fixes:          ports:6e2da9672f79f44 (filesystems: add new category)
    MFC after:      1 month
    Reviewed by:    fuz, mhorne, bapt
    Accepted by:    mhorne (mentor)
    Differential Revision:  https://reviews.freebsd.org/D48406

    (cherry picked from commit 066ef2aec187ae93a9df01d25fa8e47d67ff972b)

 release/powerpc/generate-hfs.sh          | 2 +-
 share/man/man4/ccd.4                     | 2 +-
 share/man/man5/smbfs.5                   | 2 +-
 stand/powerpc/boot1.chrp/generate-hfs.sh | 2 +-
 tools/test/stress2/misc/ext2fs.sh        | 2 +-
 tools/test/stress2/misc/ext2fs2.sh       | 2 +-
 tools/test/stress2/misc/ext2fs3.sh       | 2 +-
 tools/test/stress2/misc/ext3fs.sh        | 2 +-
 tools/test/stress2/misc/ext4fs.sh        | 2 +-
 usr.sbin/autofs/autofs/special_media     | 4 ++--
 10 files changed, 11 insertions(+), 11 deletions(-)
Comment 9 Alexander Ziaee freebsd_committer freebsd_triage 2025-02-27 02:10:07 UTC
The fix for the fallout in the src tree has been MFC'd to stable/14.

There is still a lot of fallout from the creation of a new ports category in the doc tree, much more than I know how to deal with in an efficient manner, therefore, I am going to reassign this ticket to ports@.