Page MenuHomeFreeBSD

loader: create separate man pages for each of the loaders
ClosedPublic

Authored by imp on Jul 28 2021, 9:58 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Nov 29, 8:53 PM
Unknown Object (File)
Oct 10 2024, 12:22 AM
Unknown Object (File)
Oct 4 2024, 2:22 PM
Unknown Object (File)
Oct 4 2024, 8:58 AM
Unknown Object (File)
Oct 4 2024, 8:19 AM
Unknown Object (File)
Oct 4 2024, 4:12 AM
Unknown Object (File)
Oct 2 2024, 12:05 AM
Unknown Object (File)
Oct 1 2024, 8:27 PM

Details

Summary

Create a man page per loader. Loader(8) will have information common to
all of them, while loader_${INTERP}(8) will have information relevant to
that specific loader. Rewrite loader(8) to give an overview and point to
the appropriate man page. Rewrite each of the loader_${INTER}(8) man
pages to contain only the relevant information to that loader. Put all
the common commands, environment variables, etc in loader_simp(8) and
refernce that from the loader_lua or loader_4th man pages. The
loader_lua(8) could use more details about the Lua
integration. Additional organization may be benefitial.

Sponsored by: Netflix

Test Plan

Note: this is purely a re-org commit, plus a sentence or two for pointers, etc.
A more extensive rework of lua likely is warranted.
As is a full audit of all the built-in commands and env variables.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 40733
Build 37622: arc lint + arc unit

Event Timeline

imp requested review of this revision.Jul 28 2021, 9:58 PM
imp added reviewers: kevans, tsoome.
stand/man/loader.8
3

I'm less sure this belongs here and maybe it will belong elsewhere in the future.

Just one small nit.

stand/man/loader.8
66

The .Lk macro should be used for URLs.

juan.molina_club.fr added inline comments.
stand/man/loader.8
65

s/is includes/includes/

This revision was not accepted when it landed; it landed in state Needs Review.Sep 29 2021, 3:26 PM
This revision was automatically updated to reflect the committed changes.