Page MenuHomeFreeBSD
Differential D29591

gptboot.efi: Add man page
ClosedPublic
Actions

Authored by imp on Apr 5 2021, 7:08 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Apr 19, 3:27 AM
Unknown Object (File)
Mon, Apr 14, 10:07 AM
Unknown Object (File)
Tue, Mar 25, 2:46 AM
Unknown Object (File)
Mar 6 2025, 5:35 AM
Unknown Object (File)
Mar 6 2025, 2:55 AM
Unknown Object (File)
Mar 5 2025, 9:02 PM
Unknown Object (File)
Mar 5 2025, 6:59 AM
Unknown Object (File)
Mar 5 2025, 3:48 AM
View All Files
Subscribers
bcran
crees
dab
mhorne
pstef
rpokala

Details

Reviewers
rpokala
manu
Group Reviewers
manpages
Commits
rGa12800fd291e: gptboot.efi: Add man page
rG42cd37dfbd1b: gptboot.efi: Add man page
Summary

Add a man page for gptboot.efi. Describe when and how to use this as it differes
from the BIOS cases. Include cross reference for the preferred method described
in efibootmgr(8) as well as cross links in both gptboot(8) and gptboot.efi(8) to
the other.

This man page was heavily copied from the gptboot.8 man page by Warren Block.
They are different enough to need separate man pages for clarity, but there's
enough similarity that I worry about the duplication. In the really long term,
gptboot(8) will disappear, so having the same info here will help when that
day comes.

Not fixed at this time is the need to document boot1.efi and to overhaul
loader.8 to fold in changes from the last several years.

Diff Detail

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

Event Timeline

imp created this revision.Apr 5 2021, 7:08 PM
Herald added a reviewer: manpages. · View Herald TranscriptApr 5 2021, 7:08 PM
Herald added a subscriber: bcran. · View Herald Transcript
imp requested review of this revision.Apr 5 2021, 7:08 PM
Harbormaster completed remote builds in B38331: Diff 86856.Apr 5 2021, 7:09 PM
rpokala added a subscriber: rpokala.Apr 5 2021, 7:24 PM
rpokala added inline comments.
stand/efi/gptboot/gptboot.efi.8
43

For BIOS-based computers,
.Xr gpart 8
is used instead.

BIOS-based systems use
.Xr gptboot 8
instead, which is installed with
.Xr gpart 8 .
50

When what is booted ...

73

BIOS so the next bootable item in the UEFI's Boot Manager's

firmware, so the next bootable item in the UEFIs Boot Manager's
74

list.

list is tried.
pstef added a subscriber: pstef.Apr 5 2021, 7:24 PM
pstef added inline comments.
stand/efi/gptboot/gptboot.efi.8
50

I have trouble parsing this.

crees accepted this revision as: manpages.Apr 5 2021, 7:25 PM
crees added a subscriber: crees.

A couple of suggestions inline.

stand/efi/gptboot/gptboot.efi.8
73

I wonder if you should put a comma here, or rewrite.

If it does not find an eligible partition, control is returned to the UEFI BIOS, so the next bootable item (...) list is tried.

276

Is that an alias? :)

imp updated this revision to Diff 86858.Apr 5 2021, 7:33 PM

Add better hints to look elsewhere and fix a typo.

Harbormaster completed remote builds in B38333: Diff 86858.Apr 5 2021, 7:34 PM
crees added a comment.EditedApr 5 2021, 7:37 PM

With due attention to @rpokola 's comment above, great.

stand/efi/gptboot/gptboot.efi.8
73

Sorry, last one- I think rpakola's suggestion of s,BIOS,firmware, was right here as well.

imp marked 7 inline comments as done.Apr 5 2021, 7:39 PM

updating coming, mark everything as done since I think the next update addresses these items.

imp updated this revision to Diff 86859.Apr 5 2021, 7:40 PM

Rewrite text that was unclear based on feedback from reviewers.

Harbormaster completed remote builds in B38334: Diff 86859.Apr 5 2021, 7:40 PM
imp updated this revision to Diff 86860.Apr 5 2021, 7:41 PM

minor copyright tweak due to all rights reserved being ambiguous otherwise.

Harbormaster completed remote builds in B38335: Diff 86860.Apr 5 2021, 7:41 PM
imp updated this revision to Diff 86862.Apr 5 2021, 7:52 PM

start to crossref boot1.efi. loader.efi is still hopeless.

Harbormaster completed remote builds in B38337: Diff 86862.Apr 5 2021, 7:52 PM
mhorne added a subscriber: mhorne.Apr 5 2021, 7:56 PM

This is excellent. If duplication is a concern, maybe PARTITION ATTRIBUTES could just be a pointer to gptboot.8.

stand/efi/gptboot/gptboot.efi.8
53

You might make mechanism plural, as in the previous sentence.

228
229
rpokala added inline comments.Apr 5 2021, 8:01 PM
stand/efi/gptboot/gptboot.efi.8
61

When what boots cannot depend on host-supplied UEFI variables, or
when bugs in the UEFI implementation prevent that,
.Nm
is used to bridge the gap.

Perhaps:

When deciding what to boot cannot depend on host-supplied UEFI variables,
or when bugs in the UEFI implementation prevent that,
.Nm
is used to bridge the gap.
73

"firmware"

imp marked 4 inline comments as done.Apr 5 2021, 8:02 PM
imp added inline comments.
stand/efi/gptboot/gptboot.efi.8
229

So this is now official? Cool.

imp updated this revision to Diff 86865.Apr 5 2021, 8:03 PM
imp marked an inline comment as done.

Changes from mhorne.

Harbormaster completed remote builds in B38340: Diff 86865.Apr 5 2021, 8:04 PM
imp updated this revision to Diff 86867.Apr 5 2021, 8:08 PM

More from Ravi and move definition of ESP earlier to first use.

Harbormaster completed remote builds in B38341: Diff 86867.Apr 5 2021, 8:09 PM
imp marked 2 inline comments as done.Apr 5 2021, 8:09 PM
imp added inline comments.
stand/efi/gptboot/gptboot.efi.8
61

reworded a little differently to avoid the maybe too informal / idiomatic 'bridge the gap'.

rpokala added inline comments.Apr 5 2021, 11:20 PM
stand/efi/gptboot/gptboot.efi.8
38–64

Usually the expanded version comes first, then the initialization:

is installed in the EFI System Partition (ESP).
59

s/reply/rely/

imp updated this revision to Diff 86879.Apr 6 2021, 3:13 AM
imp marked an inline comment as done.

more nits from rpokala

Harbormaster completed remote builds in B38349: Diff 86879.Apr 6 2021, 3:13 AM
imp marked 2 inline comments as done.Apr 6 2021, 3:16 AM
rpokala added inline comments.Apr 6 2021, 4:35 AM
stand/efi/gptboot/gptboot.efi.8
269

gpart isn't used for UEFI, so you can drop that. But I'd add

.Xr gptboot 8

and

.Xr loader.efi 8

(vestigial though the latter may be at the moment).

stand/i386/gptboot/gptboot.8
43

.Xr gpart.efi 8

.Xr gptboot.efi 8
imp marked 2 inline comments as done.Apr 6 2021, 4:46 AM
imp added inline comments.
stand/efi/gptboot/gptboot.efi.8
269

gpart is used with UEFI to mark partitions as bootme or bootonce.

imp updated this revision to Diff 86883.Apr 6 2021, 4:47 AM
imp marked an inline comment as done.

update for latest feedback from rpokala

Harbormaster completed remote builds in B38353: Diff 86883.Apr 6 2021, 4:47 AM
rpokala accepted this revision.Apr 6 2021, 5:00 AM
This revision is now accepted and ready to land.Apr 6 2021, 5:00 AM
Closed by commit rG42cd37dfbd1b: gptboot.efi: Add man page (authored by imp). · Explain WhyApr 6 2021, 6:02 AM
This revision was automatically updated to reflect the committed changes.
imp added a commit: rG42cd37dfbd1b: gptboot.efi: Add man page.
imp added a commit: rGa12800fd291e: gptboot.efi: Add man page.Jan 24 2023, 10:12 PM
Herald added a reviewer: manu. · View Herald TranscriptJan 24 2023, 10:12 PM
Herald added a subscriber: dab. · View Herald Transcript

Revision Contents
Changeset List

PathSize
stand/
efi/
gptboot/
1 line
efi/
gptboot/
i386/
gptboot/
gptboot.efi.8
gptboot.8
117 lines
i386/
gptboot/
6 lines
man/
14 lines

Diff 86862

View Options

stand/efi/gptboot/Makefile

.\" $FreeBSD$ .\" $FreeBSD$
Set to not build and install the enhanced Install the traditional FreeBSD
.Xr bc 1 .Xr bc 1
jhbUnsubmitted
Not Done
Inline Actions

I would maybe avoid making other changes for this commit than just the "Set to" part. Losing the Xr sections for bc and dc seems rather odd.

Granted, I would rewrite this description to be something like "Use the traditional FreeBSD versions of bc(1) and dc(1) rather than the <foo> versions." where <foo> is more descriptive than just "enhanced".

jhb: I would maybe avoid making other changes for this commit than just the "Set to" part. Losing…
emasteAuthorUnsubmitted
Done
Inline Actions

Huh, I think this must have been an accident during a rebase, I did not intend to drop these. When I first did this it was a bit of sed with manual review/touch-ups. In can incorporate feedback before this gets committed and/or we can make further improvements like this one after commit.

I am also not sure what <foo> would be off hand.

emaste: Huh, I think this must have been an accident during a rebase, I did not intend to drop these.
and and
.Xr dc 1 .Xr dc 1
programs instead of the traditional FreeBSD versions. programs instead of the enahnced versions.
emasteAuthorUnsubmitted
Done
Inline Actions

and of course I have a typo here. corrected locally.

emaste: and of course I have a typo here. corrected locally.
View Options

stand/efi/gptboot/gptboot.efi.8

.\" $FreeBSD$ .\" $FreeBSD$
Set to not build and install the enhanced Install the traditional FreeBSD
.Xr bc 1 .Xr bc 1
jhbUnsubmitted
Not Done
Inline Actions

I would maybe avoid making other changes for this commit than just the "Set to" part. Losing the Xr sections for bc and dc seems rather odd.

Granted, I would rewrite this description to be something like "Use the traditional FreeBSD versions of bc(1) and dc(1) rather than the <foo> versions." where <foo> is more descriptive than just "enhanced".

jhb: I would maybe avoid making other changes for this commit than just the "Set to" part. Losing…
emasteAuthorUnsubmitted
Done
Inline Actions

Huh, I think this must have been an accident during a rebase, I did not intend to drop these. When I first did this it was a bit of sed with manual review/touch-ups. In can incorporate feedback before this gets committed and/or we can make further improvements like this one after commit.

I am also not sure what <foo> would be off hand.

emaste: Huh, I think this must have been an accident during a rebase, I did not intend to drop these.
and and
.Xr dc 1 .Xr dc 1
programs instead of the traditional FreeBSD versions. programs instead of the enahnced versions.
emasteAuthorUnsubmitted
Done
Inline Actions

and of course I have a typo here. corrected locally.

emaste: and of course I have a typo here. corrected locally.
View Options

stand/i386/gptboot/gptboot.8

.\" $FreeBSD$ .\" $FreeBSD$
Set to not build and install the enhanced Install the traditional FreeBSD
.Xr bc 1 .Xr bc 1
jhbUnsubmitted
Not Done
Inline Actions

I would maybe avoid making other changes for this commit than just the "Set to" part. Losing the Xr sections for bc and dc seems rather odd.

Granted, I would rewrite this description to be something like "Use the traditional FreeBSD versions of bc(1) and dc(1) rather than the <foo> versions." where <foo> is more descriptive than just "enhanced".

jhb: I would maybe avoid making other changes for this commit than just the "Set to" part. Losing…
emasteAuthorUnsubmitted
Done
Inline Actions

Huh, I think this must have been an accident during a rebase, I did not intend to drop these. When I first did this it was a bit of sed with manual review/touch-ups. In can incorporate feedback before this gets committed and/or we can make further improvements like this one after commit.

I am also not sure what <foo> would be off hand.

emaste: Huh, I think this must have been an accident during a rebase, I did not intend to drop these.
and and
.Xr dc 1 .Xr dc 1
programs instead of the traditional FreeBSD versions. programs instead of the enahnced versions.
emasteAuthorUnsubmitted
Done
Inline Actions

and of course I have a typo here. corrected locally.

emaste: and of course I have a typo here. corrected locally.
View Options

stand/man/boot1.efi.8

.\" $FreeBSD$ .\" $FreeBSD$
Set to not build and install the enhanced Install the traditional FreeBSD
.Xr bc 1 .Xr bc 1
jhbUnsubmitted
Not Done
Inline Actions

I would maybe avoid making other changes for this commit than just the "Set to" part. Losing the Xr sections for bc and dc seems rather odd.

Granted, I would rewrite this description to be something like "Use the traditional FreeBSD versions of bc(1) and dc(1) rather than the <foo> versions." where <foo> is more descriptive than just "enhanced".

jhb: I would maybe avoid making other changes for this commit than just the "Set to" part. Losing…
emasteAuthorUnsubmitted
Done
Inline Actions

Huh, I think this must have been an accident during a rebase, I did not intend to drop these. When I first did this it was a bit of sed with manual review/touch-ups. In can incorporate feedback before this gets committed and/or we can make further improvements like this one after commit.

I am also not sure what <foo> would be off hand.

emaste: Huh, I think this must have been an accident during a rebase, I did not intend to drop these.
and and
.Xr dc 1 .Xr dc 1
programs instead of the traditional FreeBSD versions. programs instead of the enahnced versions.
emasteAuthorUnsubmitted
Done
Inline Actions

and of course I have a typo here. corrected locally.

emaste: and of course I have a typo here. corrected locally.