Bug 283060

Summary:	Improper use of reverse solidus \ in hardware notes
Product:	Documentation	Reporter:	Graham Perrin <grahamperrin>
Component:	Website	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Open ---
Severity:	Affects Many People	CC:	doceng, fernape, re, ziaee
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any
URL:	https://github.com/freebsd/freebsd-doc/blob/main/website/content/en/releases/14.2R/hardware.adoc

Description Graham Perrin 2024-12-01 03:52:47 UTC

28th November, <https://discord.com/channels/727023752348434432/760416197803245591/1311786706164383774>: 

> I did like the links to manual pages. Will those come back in future 
> hardware notes? 

For a while, I thought that I had imagined the links. 

A few hours ago, something looked wrong when the verbatim quote at <https://old.reddit.com/r/freebsd/comments/1h3it1q/alderlake_no_hdmi_audio_i915kms/lzsertm/> included: 

> snd\_hda

Now, I _do_ see links to manual pages under, for example: 

<https://www.freebsd.org/releases/13.0R/hardware/#sound> 👍

----

<https://www.freebsd.org/releases/14.0R/hardware/#sound> lacked links.

<https://www.freebsd.org/releases/13.1R/hardware/#sound> lacked links, 
and is bugged with the \ reverse solidus. 

<https://www.freebsd.org/releases/14.1R/hardware/#sound> and 
<https://www.freebsd.org/releases/14.2R/hardware/#sound> are similarly bugged.

----

Please note, the \ bug is not limited to the 'Sound devices' section of affected pages. The #sound anchor above, for comparison, is only because I found 
snd\_hda where I expected to find 
snd_hda(4)

<https://man.freebsd.org/cgi/man.cgi?query=snd_hda&sektion=4&manpath=freebsd-release>

Comment 1 Alexander Ziaee freebsd_triage

2024-12-01 18:35:05 UTC

What would be lovely is if the tooling that converts the HARDWARE section of manual pages to the hw relnotes would take the Nm and replace it with a link to man.freebsd.org, but this is beyond my skill level.