linux(4): man page tweaks
ClosedPublic
Actions

Authored by trasz on Jan 2 2022, 4:21 PM.

Details

Reviewers

emaste
debdrup

Group Reviewers

manpages
Linux Emulation

Commits

Summary

Advertise rc.conf method as the right way to enable it, mention
file system mapping... and change some wording.

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 43693
Build 40581: arc lint + arc unit

trasz requested review of this revision.Jan 2 2022, 4:21 PM

A couple of little comments, overall looks good thanks for updating this!

share/man/man4/linux.4
34–35	maybe `the Linux ABI at boot time`?
56	I think the , isn't needed here
59–78	I might get rid of try to. Whether or not the translated path was found, they do perform the look up. Or "try to access file paths" or "try to reference file paths" or some such?
65	comma splice - make it a ., and start a new sentence with the next part. Can expand e.g. to For example, when Linux... to make it a reasonable start to the sentence
82	We have some other linux packages in the works too, right?
125	We should perhaps leave a note in the source with a reference back to this man page, such that if someone ever changed it they would find a hint to update here too.

Tweaks.

trasz marked 2 inline comments as done.Jan 2 2022, 9:24 PM

trasz added inline comments.

share/man/man4/linux.4
56	How about just removing this part altogether? It's redundant, might be confusing (because there are more than those two involved), and isn't even technically true (because those two are separate kernel modules).
82	We do, we should document https://reviews.freebsd.org/D33652, also debootstrap. But let's do that in a separate commit.
125	I don't think this will ever change, this looks more like a magic number. One that will change is the kernel version, and that's why I've left it undocumented for now.