FreeBSD/doc
1
0
Fork 0
mirror of https://git.FreeBSD.org/doc.git synced 2026-06-02 11:25:20 +00:00
Code Issues Projects Releases Wiki Activity

website: improve hardware-notes-processor.rb

Browse Source 
fixes mandoc generation of left bracket
adds messages, when HARDWARE section is absent or empty
remains hwlist macro in hardware.adoc for next cycles
hwlist macro has warning message text in the same line

Reviewed by: carlavilla
Approved by: carlavilla
Differential Revision: https://reviews.freebsd.org/D57133
This commit is contained in:
Vladlen Popolitov
2026-05-21 10:09:49 +03:00
parent d3dd5e6afd
commit 040006ae08
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/tools/hardware-notes-processor.rb
+14 -2
View File
@@ -23,14 +23,16 @@ hardwareNotesContent = ""
File.foreach(hardwareNotesPath).with_index do |line|
if (line[/&hwlist.\b/])
manualPage = line.gsub("&hwlist.", "").gsub(";", "").gsub("\n", "")
macro = line.match(/&hwlist\.[^\s;]+;?/)[0]
manualPage = macro.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
#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"
@@ -56,10 +58,20 @@ File.foreach(hardwareNotesPath).with_index do |line|
end
end
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 << line