Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 08 Jun 2026 20:23:31 +0000
From:      bugzilla-noreply@freebsd.org
To:        bugs@FreeBSD.org
Subject:   [Bug 295944] loader.efi(8): Outdated wording in reference to uart(4)
Message-ID:  <bug-295944-227@https.bugs.freebsd.org/bugzilla/>

index | next in thread | raw e-mail

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=295944

            Bug ID: 295944
           Summary: loader.efi(8): Outdated wording in reference to
                    uart(4)
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Manual Pages
          Assignee: bugs@FreeBSD.org
          Reporter: calebharp2005@gmail.com
                CC: doc@FreeBSD.org

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.

-- 
You are receiving this mail because:
You are the assignee for the bug.

home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?bug-295944-227>