Project

General

Profile

Actions

Bug #14900

closed

ddi_fm_capable(9F) man page does not match source

Added by Benjamin Naecker about 2 months ago. Updated about 2 months ago.

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

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
External Bug:

Description

The man page for `ddi_fm_capable(9F)` shows a signature that does not match the actual source. The signature in the man page is:

int ddi_fm_capable(dev_info_t *dip, int *fm_capability)

The capability is passed by pointer, and modified internally to incorporate the parent device's capabilities. However, in the source, the signature is:

int ddi_fm_capable(dev_info_t *dip)

The function instead returns the value incorporating the parent's capabilities. The man page should be updated to reflect the current implementation. The current man page can be found here, and the current source here.

Actions #1

Updated by Electric Monk about 2 months ago

  • Gerrit CR set to 2302
Actions #2

Updated by Robert Mustacchi about 2 months ago

  • Category set to manpage - manual pages
  • Assignee set to Benjamin Naecker
Actions #3

Updated by Electric Monk about 2 months ago

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

git commit 46dc144bc2859392d4c62f3e72d661e7b3c22a8e

commit  46dc144bc2859392d4c62f3e72d661e7b3c22a8e
Author: Benjamin Naecker <bnaecker@fastmail.com>
Date:   2022-08-12T18:57:22.000Z

    14900 ddi_fm_capable(9F) man page does not match source
    Reviewed by: Robert Mustacchi <rm@fingolfin.org>
    Approved by: Dan McDonald <danmcd@mnx.io>

Actions #4

Updated by Joshua M. Clulow about 2 months ago

Testing Notes (from RTI mail)

This is a man-page change so the testing included building a new BE from the updated sources, and running man ddi_fm_capable, which confirms that the new signature matches the source.

Actions

Also available in: Atom PDF