Project

General

Profile

Bug #11639

some man pages show incorrect driver locations

Added by Peter Tribble 10 months ago. Updated 6 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
manpage - manual pages
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

Some man pages in section 7d have errors in the filename for the driver.

For example, ieee1394 has

/kernel/misc/[sparcv9|amd64/]s1394

where the / ought to be outside the [] so it applies to sparcv9 as well.

Some, like usba, say sparcv rather than sparcv9

Some, like usba, miss the leading / on the path.

And it would be a good opportunity to start clearing up the 32-bit remnants.

History

#1

Updated by Yuri Pankov 10 months ago

There's a question if the driver location has to be in man page at all, it's helpful when?

#2

Updated by Peter Tribble 10 months ago

There's useful information embedded in the location; not just the driver name but type, sometimes the note of platform-specific changes. And sometimes the configuration file is useful to know where to look.

Not so universally critical that we need to make a policy that every man page include it, but not so useless that it's worth eradicating.

What we shouldn't do is have information that's factually incorrect.

#3

Updated by Electric Monk 6 months ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit f3065a883c2d0dfcd5ac6f21692e95c945b23d2c

commit  f3065a883c2d0dfcd5ac6f21692e95c945b23d2c
Author: Peter Tribble <peter.tribble@gmail.com>
Date:   2020-01-14T08:09:59.000Z

    11639 some man pages show incorrect driver locations
    Reviewed by: Robert Mustacchi <rm@fingolfin.org>
    Reviewed by: Toomas Soome <tsoome@me.com>
    Approved by: Dan McDonald <danmcd@joyent.com>

Also available in: Atom PDF