Bug 2185893

Summary: Hostapd.conf man page "SEE ALSO" refers to example with incorrect path
Product: [Fedora] Fedora Reporter: Tom Sobczynski <tsobczynski>
Component: hostapdAssignee: John W. Linville <linville>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: unspecified    
Version: 37CC: dcaratti, linville, negativo17, tsobczynski
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-04-11 19:43:51 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Patch for hostapd.conf.5 none

Description Tom Sobczynski 2023-04-11 14:20:15 UTC
Description of problem:

The man page for hostapd.conf contains a "SEE ALSO" item that is an absolute path to a sample hostapd.conf file:

SEE ALSO
       hostapd(8), hostapd_cli(8), /usr/share/examples/hostapd/hostapd.conf

But when Fedora packages hostapd, the destination for this example is a different location:

$ rpm -ql hostapd | grep hostapd.conf
/etc/hostapd/hostapd.conf
/usr/share/doc/hostapd/hostapd.conf

Version-Release number of selected component (if applicable):
hostapd v2.10 on Fedora 37

How reproducible:
100%

Steps to Reproduce:
1. Open the man page for hostapd.conf ($ man hostapd.conf)
2. Navigate to the "SEE ALSO" section
3. Note the path of the example config file
4. Attempt to view that config file, see that it does not exist.

Actual results:
There is no file with that path name.

Expected results:
The man page should be patched at build time to reflect the actual location of the example when the hostapd package is installed.

Additional info:

Comment 1 Tom Sobczynski 2023-04-11 14:46:18 UTC
Created attachment 1956863 [details]
Patch for hostapd.conf.5

Supplying proposed patch based on clone from https://src.fedoraproject.org/rpms/hostapd/blob/main/f/hostapd.conf.5