1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
#!/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
hardwareNotesPath = ARGV[0]
hardwareNotesContent = ""
File.foreach(hardwareNotesPath).with_index do |line|
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 _ in drivers name and description
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
hardwareNotesContent << mandocOut
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
|
