Page MenuHomeFreeBSD

website: improve hardware-notes-processor.rb
ClosedPublic

Authored by vladlen on May 20 2026, 5:56 PM.
Tags
Referenced Files
F160325550: D57133.id.diff
Tue, Jun 23, 7:33 AM
Unknown Object (File)
Mon, Jun 22, 1:48 AM
Unknown Object (File)
Sun, Jun 21, 11:33 AM
Unknown Object (File)
Sat, Jun 20, 9:50 PM
Unknown Object (File)
Thu, Jun 4, 1:10 PM
Unknown Object (File)
Thu, Jun 4, 2:28 AM
Unknown Object (File)
Thu, Jun 4, 2:22 AM
Unknown Object (File)
Mon, Jun 1, 10:12 PM
Subscribers
None

Details

Summary

It is the same macro with additional output, that can simplify hardware.adoc processing.

  1. fixes mandoc generation of left bracket (the same as \_ before)
  2. adds messages to the screen, when HARDWARE section is absent or empty (before they skipped silently)
  3. writes hwlist macro into hardware.adoc for next cycles.

It allows to run make again with the same file and update information about drivers as soon as

    • new man pages added
    • HARDWARE section is added to a man page.
  1. The line with hwlist macro has warning message text in the same line (4 spaces to the rigth) - to search

in the hardware.adoc and make actions based on error message.

How it works:

With this version of the script we need to copy hardware.adoc from template
first and only one time in the begining of the release cycle,
and run make generate-hardware-notes as many times as needed.
If that specific release does not support some drivers, these lines can be removed in any moment
from hardware.adoc. In day before release date all unsupported drivers must be removed finally.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

This version showed warnings

WARNING: The manual page man4.i386/ep does not exists
WARNING: The manual page man4.i386/ex does not exists
WARNING: The manual page man4.i386/fe does not exists
WARNING: The manual page hme does not exists
WARNING: The manual page pcn does not exists
WARNING: The manual page sf does not exists
WARNING: The manual page sn does not exists
WARNING: The manual page tl does not exists
WARNING: The manual page txp does not exists
WARNING: The manual page man4.i386/vx does not exists
WARNING: The manual page wb does not exists
WARNING: The manual page xe does not exists
WARNING: The manual page man4.i386/ce does not exists
WARNING: The manual page man4.i386/cx does not exists
WARNING: The manual page man4.i386/cp does not exists
WARNING: The manual page man4.i386/ctau does not exists
WARNING: The manual page ufintek does not exists
WARNING: No HARDWARE section content for manual page umoscom

For me is ok, thanks for the improvements you are making to this tool

This revision is now accepted and ready to land.May 21 2026, 5:52 AM