Bug 265834 - loader.efi(8) should mention uefi(8) and vice versa; loader(8) should mention loader.efi(8) and vice versa …
Summary: loader.efi(8) should mention uefi(8) and vice versa; loader(8) should mention...
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-08-14 13:50 UTC by Graham Perrin
Modified: 2023-09-11 22:37 UTC (History)
7 users (show)

See Also:


Attachments
Patch uefi(8) as suggested (781 bytes, patch)
2023-02-11 22:47 UTC, Tom Hukins
no flags Details | Diff
Patch uefi(8) as suggested (929 bytes, patch)
2023-06-13 17:32 UTC, Tom Hukins
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2022-08-14 13:50:31 UTC
loader(8) 
<https://www.freebsd.org/cgi/man.cgi?query=loader&sektion=8&manpath=FreeBSD>

* does not mention loader.efi(8)


loader.efi(8) 
<https://www.freebsd.org/cgi/man.cgi?query=loader.efi&sektion=8&manpath=FreeBSD>

* does not mention loader(8) or uefi(8)


uefi(8) 
<https://www.freebsd.org/cgi/man.cgi?query=uefi&sektion=8&manpath=FreeBSD>

* mentions loader.efi but not loader.efi(8)
Comment 1 Li-Wen Hsu freebsd_committer freebsd_triage 2022-08-14 16:54:26 UTC
Please feel free to work with your mentor to update those manual pages, doc committers are encouraged to work on the doc parts in the src repo.
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-08-14 17:50:13 UTC
(In reply to Li-Wen Hsu from comment #1)

The coding that's used for manual pages is not my strength. 

If anyone else would like to make a start on this, whilst I'm away: you're welcome.
Comment 3 Tom Hukins 2023-02-11 22:47:14 UTC
Created attachment 240099 [details]
Patch uefi(8) as suggested

I notice that the suggested changes to loader(8) and loader.efi(8) have already been made.

The attached patch resolves the final issue with uefi(8).  Please apply it using `git am 0001-Refer-to-a-related-manual-page.patch` to resolve this issue.
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2023-04-14 20:58:45 UTC
(In reply to Tom Hukins from comment #3)

I used the content of <https://bz-attachments.freebsd.org/attachment.cgi?id=240099>, which includes the 'From:' line, to create the diff in Phabricator. 

Is the author information (you) hidden somewhere in Phabricator? I see only my name as author, which is wrong.
Comment 5 Tom Hukins 2023-04-14 21:09:49 UTC
(In reply to Graham Perrin from comment #4)

I haven't used Phabricator yet, so I don't know.  Like you, I see nothing at https://reviews.freebsd.org/D39577 that includes my commit message or committer details.

Let me know if it would help for me to create a Phabricator account or if there's anything else I can do to help with this ticket.
Comment 6 Graham Perrin freebsd_committer freebsd_triage 2023-04-14 21:28:48 UTC
(In reply to Tom Hukins from comment #5)

Thanks, it makes more sense to me after seeing <https://git-scm.com/docs/git-am>. 

When the time comes, I'll make a separate commit. 

(In reply to Tom Hukins from comment #3)

> … the suggested changes to loader(8) and loader.efi(8) have already been 
> made. …

Found: cherry-pick <https://github.com/freebsd/freebsd-src/commit/80a80b130ab1f2be89a17758baab48ec04de7444> (2023-01-24).
Comment 7 Tomasz "CeDeROM" CEDRO 2023-04-14 21:47:00 UTC
Please also add description with examples of EFIBOOTMGR !!

This utility is completely missed in the uefi docs / manpages and this was crucial to fix uefi boot on my machine after migration to a different hardware.

When there was no boot entry for FreeBSD I had to select boot device from BIOS.

I know this is done but bsdinstall but sometimes user needs to do the work by hand.


It took me some time to find that utility and understand how it works :-) :-)

Thanks :-)
Comment 8 Graham Perrin freebsd_committer freebsd_triage 2023-04-14 21:56:02 UTC
(In reply to Tomasz "CeDeROM" CEDRO from comment #7)

> … EFIBOOTMGR !!
> 
> This utility is completely missed in the uefi docs / manpages …

efibootmgr(8) does now appear under <https://man.freebsd.org/cgi/man.cgi?query=loader.efi&sektion=8&manpath=freebsd-release#DESCRIPTION> and <https://man.freebsd.org/cgi/man.cgi?query=uefi&sektion=8&manpath=freebsd-release#SEE_ALSO>.
Comment 9 Tomasz "CeDeROM" CEDRO 2023-04-14 22:35:18 UTC
TANK U SIR!! =)
Comment 10 Tom Hukins 2023-06-13 17:32:08 UTC
Created attachment 242763 [details]
Patch uefi(8) as suggested
Comment 11 commit-hook freebsd_committer freebsd_triage 2023-09-04 19:27:44 UTC
A commit in branch main references this bug:

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

commit f49d6f583e9df2839b420f27c44edc5c1fa276c6
Author:     Tom Hukins <tom@FreeBSD.org>
AuthorDate: 2023-08-31 09:21:40 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-09-04 19:22:30 +0000

    uefi(8): Refer to a related manual page

    PR:     265834
    Reviewed by:    mhorne
    MFC after:      3 days
    Differential Revision: https://reviews.freebsd.org/D39577

 share/man/man8/uefi.8 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Comment 12 Tom Hukins 2023-09-04 19:55:08 UTC
I suggest this ticket have its status updated to "fixed" now that the three issues in the initial report have been resolved.
Comment 13 Mitchell Horne freebsd_committer freebsd_triage 2023-09-04 20:06:09 UTC
(In reply to Tom Hukins from comment #12)

Once I have merged this last change to stable branches, I will mark it as closed&fixed.
Comment 14 commit-hook freebsd_committer freebsd_triage 2023-09-11 21:43:24 UTC
A commit in branch stable/14 references this bug:

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

commit d01bbdf4572bd8e8e709f6c0020e7352f7727cff
Author:     Tom Hukins <tom@FreeBSD.org>
AuthorDate: 2023-08-31 09:21:40 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-09-11 21:42:03 +0000

    uefi(8): Refer to a related manual page

    PR:     265834
    Reviewed by:    mhorne
    MFC after:      3 days
    Differential Revision: https://reviews.freebsd.org/D39577

    (cherry picked from commit f49d6f583e9df2839b420f27c44edc5c1fa276c6)

 share/man/man8/uefi.8 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Comment 15 commit-hook freebsd_committer freebsd_triage 2023-09-11 21:45:26 UTC
A commit in branch stable/13 references this bug:

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

commit 9c6710cd2453b84b115bbdc029de74876fcf6b2f
Author:     Tom Hukins <tom@FreeBSD.org>
AuthorDate: 2023-08-31 09:21:40 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-09-11 21:44:24 +0000

    uefi(8): Refer to a related manual page

    PR:     265834
    Reviewed by:    mhorne
    MFC after:      3 days
    Differential Revision: https://reviews.freebsd.org/D39577

    (cherry picked from commit f49d6f583e9df2839b420f27c44edc5c1fa276c6)

 share/man/man8/uefi.8 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Comment 16 commit-hook freebsd_committer freebsd_triage 2023-09-11 22:36:44 UTC
A commit in branch releng/14.0 references this bug:

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

commit 481d727f3ede5362991b89545f072c28c07745c5
Author:     Tom Hukins <tom@FreeBSD.org>
AuthorDate: 2023-08-31 09:21:40 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-09-11 22:34:08 +0000

    uefi(8): Refer to a related manual page

    PR:     265834
    Reviewed by:    mhorne
    Approved by:    re (delphij)
    Differential Revision: https://reviews.freebsd.org/D39577

    (cherry picked from commit f49d6f583e9df2839b420f27c44edc5c1fa276c6)
    (cherry picked from commit d01bbdf4572bd8e8e709f6c0020e7352f7727cff)

 share/man/man8/uefi.8 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)