mirror of
https://git.FreeBSD.org/doc.git
synced 2026-06-02 19:35:07 +00:00
Vladlen Popolitov
d3abd0466d
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
105 lines
2.8 KiB
Ruby
105 lines
2.8 KiB
Ruby
#!/usr/bin/env ruby
|
|
=begin
|
|
|
|
BSD 2-Clause License
|
|
Copyright (c) 2020-2026, The FreeBSD Project
|
|
Copyright (c) 2020-2026, Sergio Carlavilla <carlavilla@FreeBSD.org>
|
|
|
|
This script will generate the hardware notes
|
|
|
|
=end
|
|
require 'open3'
|
|
|
|
# Main method
|
|
puts "Processing hardware notes..."
|
|
|
|
if ARGV.length < 1 || ARGV.length > 1
|
|
puts "Only expecting the release version"
|
|
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 |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/])
|
|
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; }'"
|
|
mandocOut, err, s = Open3::capture3(cmd)
|
|
if s.success?
|
|
#replace \_ to _ and \[ to [ in drivers name and description
|
|
mandocOut.gsub!(/\\_/, '_')
|
|
mandocOut.gsub!(/\\\[/, '[')
|
|
|
|
# extract Nm (real driver name)
|
|
nm_cmd = "grep -m1 '^\\.Nm' tmp/share/man/man4/#{manualPage}.4"
|
|
nmOut, err2, s2 = Open3.capture3(nm_cmd)
|
|
|
|
if s2.success?
|
|
|
|
nm = nmOut.split[1]
|
|
|
|
if nm && !nm.empty?
|
|
driverName = File.basename(manualPage)
|
|
|
|
if nm != driverName
|
|
# f.e man ar40xx has driver name ar40xx_switch
|
|
man_link = "link:https://man.freebsd.org/cgi/man.cgi?query=#{driverName}&apropos=&&sektion=4&format=html[#{nm}]"
|
|
else
|
|
man_link = "man:#{driverName}[4]"
|
|
end
|
|
# replace only first occurrence, preserving markdown formatting
|
|
mandocOut.sub!(/[*_]*#{nm}[*_]*/) do
|
|
man_link
|
|
end
|
|
end
|
|
end
|
|
|
|
if mandocOut.strip.empty?
|
|
puts "WARNING: No HARDWARE section content for manual page #{manualPage}"
|
|
next
|
|
end
|
|
|
|
hardwareNotesContent << mandocOut
|
|
else
|
|
puts "WARNING: The manual page " + manualPage + " without HARDWARE exists or malformed"
|
|
end
|
|
else
|
|
puts "WARNING: The manual page " + manualPage + " does not exists"
|
|
end
|
|
else
|
|
hardwareNotesContent << line
|
|
end
|
|
end
|
|
|
|
File.open(hardwareNotesPath, 'w') do |out|
|
|
out << hardwareNotesContent
|
|
end
|