Bug 295944 - loader.efi(8): Outdated wording in reference to uart(4)
Summary: loader.efi(8): Outdated wording in reference to uart(4)
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Alexander Ziaee
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2026-06-08 20:23 UTC by Caleb Harper
Modified: 2026-06-28 00:45 UTC (History)
2 users (show)

See Also:


Attachments
Patch equivalent to the one in the original comment, generated with `git diff`. (428 bytes, patch)
2026-06-08 22:25 UTC, Caleb Harper
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Caleb Harper 2026-06-08 20:23:31 UTC
In the loader.efi(8) man page, the hw.uart.console variable is briefly explained. The page states that the format of this variable should be documented in uart(4) but it is not. However, the current version of uart(4) does document the format of this variable(which probably means that bug #277848 should also be closed as fixed). I encountered this issue when attempting to set up an embedded device with a UART terminal, and it would probably be good to let future readers know that the documentation does exist.

I first discovered this wording on 15.0 but have confirmed that it still exists in 16.0-CURRENT.

Existing wording:
The FreeBSD kernel will look at the hw.uart.console variable to set its serial console. Its format should be described in uart(4) but is not.

Suggested wording:
The FreeBSD kernel will look at the hw.uart.console variable to set its serial console. Its format is described in uart(4).

Or, if a diff is more helpful:

--- stand/man/loader.efi.8	2026-06-08 15:21:01.454615000 -0500
+++ stand/man/loader.efi.8	2026-06-08 15:21:25.305200000 -0500
@@ -150,9 +150,8 @@
 kernel will look at the
 .Dv hw.uart.console
 variable to set its serial console.
-Its format should be described in
-.Xr uart 4
-but is not.
+Its format is described in
+.Xr uart 4 .
 Set it to
 .Dq io:0x3f8,br:115200
 with the proper port address.
Comment 1 Mark Linimon freebsd_committer freebsd_triage 2026-06-08 21:33:59 UTC
^Triage: note that this Problem Report contains an inline diff.  (These days,
we do prefer Attachments having been made with git diff.)
Comment 2 Caleb Harper 2026-06-08 22:25:31 UTC
Created attachment 271633 [details]
Patch equivalent to the one in the original comment, generated with `git diff`.

Adding a git-formatted version of that diff. Sorry, I'm new here.
Comment 3 Mark Linimon freebsd_committer freebsd_triage 2026-06-08 22:36:06 UTC
^Triage: to be fair, we are trying (slowly) to modernize our processes.
Comment 4 Alexander Ziaee freebsd_committer freebsd_triage 2026-06-15 22:57:09 UTC
Thanks!
Comment 5 commit-hook freebsd_committer freebsd_triage 2026-06-15 22:57:37 UTC
A commit in branch main references this bug:

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

commit a641aa1c80f80e44cd9212b95e6584db9533712c
Author:     Caleb Harper <calebharp2005@gmail.com>
AuthorDate: 2026-06-15 22:51:05 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-06-15 22:56:01 +0000

    loader.efi.8: hw.uart.console is explained in uart

    PR:             295944
    MFC to:         15
    MFC after:      3 days

 stand/man/loader.efi.8 | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
Comment 6 commit-hook freebsd_committer freebsd_triage 2026-06-28 00:45:10 UTC
A commit in branch stable/15 references this bug:

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

commit fa550b255e957a3ec0707cf1308eac92cf4b2e08
Author:     Caleb Harper <calebharp2005@gmail.com>
AuthorDate: 2026-06-15 22:51:05 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-06-28 00:36:10 +0000

    loader.efi.8: hw.uart.console is explained in uart

    PR:             295944
    MFC to:         15
    MFC after:      3 days

    (cherry picked from commit a641aa1c80f80e44cd9212b95e6584db9533712c)

 stand/man/loader.efi.8 | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)