Date: Wed, 27 May 2026 20:21:18 +0000 From: Vladlen Popolitov <vladlen@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: d3abd0466d - main - website: improve hardware-notes-processor.rb Message-ID: <6a17523e.1f480.63338647@gitrepo.freebsd.org>
index | next in thread | raw e-mail
The branch main has been updated by vladlen: URL: https://cgit.FreeBSD.org/doc/commit/?id=d3abd0466d8b96f39c1b97ab5f4a8933411d1349 commit d3abd0466d8b96f39c1b97ab5f4a8933411d1349 Author: Vladlen Popolitov <vladlen@FreeBSD.org> AuthorDate: 2026-05-27 20:21:06 +0000 Commit: Vladlen Popolitov <vladlen@FreeBSD.org> CommitDate: 2026-05-27 20:21:06 +0000 website: improve hardware-notes-processor.rb 1. warning in hardware.adoc removed 2. release version in hardware.adoc substituted from src repo Reviewed by: cperciva, carlavilla Approved by: cperciva, carlavilla Differential Revision: https://reviews.freebsd.org/D57262 --- website/tools/hardware-notes-processor.rb | 33 +++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/website/tools/hardware-notes-processor.rb b/website/tools/hardware-notes-processor.rb index 1974bf2aea..0cc43f029b 100644 --- a/website/tools/hardware-notes-processor.rb +++ b/website/tools/hardware-notes-processor.rb @@ -18,13 +18,37 @@ if ARGV.length < 1 || ARGV.length > 1 exit end +# Extract FreeBSD version from newvers.sh +freebsd_version = nil +newvers_path = './tmp/sys/conf/newvers.sh' +if File.exist?(newvers_path) + File.foreach(newvers_path) do |line| + if line =~ /REVISION="([^"]+)"/ + freebsd_version = $1 + break + end + end +end + +if freebsd_version.nil? + puts "WARNING: Could not find FreeBSD version in #{newvers_path}" + freebsd_version = 'X.Y' +end + hardwareNotesPath = ARGV[0] hardwareNotesContent = "" -File.foreach(hardwareNotesPath).with_index do |line| +File.foreach(hardwareNotesPath).with_index do |original_line, idx| + line = original_line.dup # allow modification + + # Replace version placeholders in the first 10 lines + if idx < 10 + line.gsub!(/X\.0/, freebsd_version) + line.gsub!(/X\.Y/, freebsd_version) + end + if (line[/&hwlist.\b/]) - macro = line.match(/&hwlist\.[^\s;]+;?/)[0] - manualPage = macro.gsub("&hwlist.", "").gsub(";", "").gsub("\n", "") + manualPage = line.gsub("&hwlist.", "").gsub(";", "").gsub("\n", "") if(File.exist?("tmp/share/man/man4/" + manualPage + ".4")) cmd = "mandoc -Tmarkdown tmp/share/man/man4/" + manualPage + ".4 | sed -n '/^# HARDWARE/,/^# /{ /^# /d; p; }'" @@ -60,18 +84,15 @@ File.foreach(hardwareNotesPath).with_index do |line| if mandocOut.strip.empty? puts "WARNING: No HARDWARE section content for manual page #{manualPage}" - hardwareNotesContent << "#{macro} WARNING: No HARDWARE section content for manual page #{manualPage}\n" next end hardwareNotesContent << mandocOut else puts "WARNING: The manual page " + manualPage + " without HARDWARE exists or malformed" - hardwareNotesContent << "#{macro} WARNING: The manual page " + manualPage + " without HARDWARE exists or malformed\n" end else puts "WARNING: The manual page " + manualPage + " does not exists" - hardwareNotesContent << "#{macro} WARNING: The manual page " + manualPage + " does not exists\n" end else hardwareNotesContent << linehome | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?6a17523e.1f480.63338647>
