Bug 232587 - devinfo.8 contains undefined reference to pnpinfo.8
Summary: devinfo.8 contains undefined reference to pnpinfo.8
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Guangyuan Yang
URL:
Keywords: easy, patch
Depends on:
Blocks:
 
Reported: 2018-10-24 00:28 UTC by Graham Perrin
Modified: 2021-11-05 04:56 UTC (History)
6 users (show)

See Also:

Attachments
devinfo(8) patch (343 bytes, patch)
2021-09-20 03:41 UTC, Felix Johnson 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2018-10-24 00:28:59 UTC 
$ man devinfo | tail -n 8
SEE ALSO
     systat(1), devinfo(3), iostat(8), pciconf(8), pnpinfo(8), vmstat(8),
     devclass(9), device(9)

AUTHORS
     Mike Smith <msmith@FreeBSD.org>

FreeBSD 12.0-BETA1             December 21, 2017            FreeBSD 12.0-BETA1
$ man pnpinfo
No manual entry for pnpinfo
$
Comment 1 Conrad Meyer freebsd_committer freebsd_triage 2018-10-24 00:38:27 UTC 
The line dates to 2002, when the command was initially documented.  It's not clear to me if pnpinfo.8 existed at the time, or not.

MODULE_PNP_INFO(9) is sort of related, although usually we don't Xr straight from section 8 to section 9.
Comment 2 Conrad Meyer freebsd_committer freebsd_triage 2018-10-24 00:39:57 UTC 
It does not appear there was any bin directory named pnpinfo at the time.  Maybe as a secondary program from some other directory.
Comment 3 Yuri Pankov freebsd_committer freebsd_triage 2018-10-24 00:47:47 UTC 
It seems it did actually exist back then:

$ git checkout c57dc2b4a808f4a7ef86e2ef7519d4783f2f0fac (that's r96458 where devinfo man page was added)
$ $ find . -name \*pnpinfo\*
./contrib/pnpinfo
./contrib/pnpinfo/pnpinfo.8
./contrib/pnpinfo/pnpinfo.h
./contrib/pnpinfo/pnpinfo.c
./usr.sbin/pnpinfo
Comment 4 Conrad Meyer freebsd_committer freebsd_triage 2018-10-24 01:35:47 UTC 
Ah, nice find.  I was only looking for '{,usr.}{,s}bin/pnpinfo/pnpinfo.8'.
Comment 5 Felix Johnson 2021-09-20 03:41:52 UTC 
Created attachment 228038 [details]
devinfo(8) patch

Remove cross-reference to pnpinfo(8).
Comment 6 commit-hook freebsd_committer freebsd_triage 2021-11-01 16:36:15 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=dde6071adcf203b185c185289f687c2bd51532fb

commit dde6071adcf203b185c185289f687c2bd51532fb
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-01 16:29:12 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-01 16:29:12 +0000

    devinfo(8): Remove cross-reference to pnpinfo(8)

    devinfo(8) manpage contains reference to pnpinfo(8) which existed at the
    time. Remove it.

    PR:             232587
    MFC:            3 days
    Reported by:    Graham Perrin <grahamperrin@gmail.com>

 usr.sbin/devinfo/devinfo.8 | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
Comment 7 commit-hook freebsd_committer freebsd_triage 2021-11-05 04:55:24 UTC 
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=78bec4ed648f030b821be10920b636fc9788a735

commit 78bec4ed648f030b821be10920b636fc9788a735
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-01 16:29:12 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-05 04:54:33 +0000

    devinfo(8): Remove cross-reference to pnpinfo(8)

    devinfo(8) manpage contains reference to pnpinfo(8) which existed at the
    time. Remove it.

    PR:             232587
    Reported by:    Graham Perrin <grahamperrin@gmail.com>

    (cherry picked from commit dde6071adcf203b185c185289f687c2bd51532fb)

 usr.sbin/devinfo/devinfo.8 | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)