Project

General

Profile

Actions

Bug #14457

closed

scsi_address(9S): only a_target/a_lun should be described as opaque

Added by Yuri Pankov 7 months ago. Updated 7 months ago.

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

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

scsi_address(9S) says that the entire struct scsi_address is opaque if SCSI_HBA_ADDR_COMPLEX was set, however it does not seem entirely correct -- drivers use the a_hba_tran field, and there does not seem to be any reason not to.

While here, there are various formatting issues, e.g. missing newline before the "If the SCSI target" in:

     In the case where only the target component is used to address the
     device, the logical unit should be set to 0. If the SCSI target device
     supports logical units, then the HBA must interpret the logical units
     field of the data structure.

...(mandoc -Tlint does not have anything to say about it for some reason)

The
.Sy pkt_address
member of a
.Xr scsi_pkt 9S
is initialized by
.Xr scsi_init_pkt 9F .

pkt_address should likely be a .Va here.

Also, it could be just a matter of taste, but highlighting HBA, SCSI, and other items seems to draw attention away from what's important.

Actions #1

Updated by Robert Mustacchi 7 months ago

  • Assignee set to Robert Mustacchi
Actions #2

Updated by Robert Mustacchi 7 months ago

On pkt_address, those actually should be a .Fa which is something I wasn't aware of at the time of originally writing this. modc(5) says "This macro is also used to specify the field name of a structure.".

Actions #3

Updated by Robert Mustacchi 7 months ago

Regarding the bolding, when I translated this from roff, I did preserve that part of the original formatting. I'll evaluate making this look a little better (with the understanding that it's always going to be subjective).

Actions #4

Updated by Electric Monk 7 months ago

  • Gerrit CR set to 1991
Actions #5

Updated by Robert Mustacchi 7 months ago

I tested this by looking at the new page in man.

Actions #6

Updated by Electric Monk 7 months ago

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

git commit e2d5561a2e4376608422303f917fd80a7ed70298

commit  e2d5561a2e4376608422303f917fd80a7ed70298
Author: Robert Mustacchi <rm@fingolfin.org>
Date:   2022-02-01T15:40:56.000Z

    14457 scsi_address(9S): only a_target/a_lun should be described as opaque
    Reviewed by: C Fraire <cfraire@me.com>
    Reviewed by: Yuri Pankov <ypankov@tintri.com>
    Reviewed by: Toomas Soome <tsoome@me.com>
    Approved by: Rich Lowe <richlowe@richlowe.net>

Actions

Also available in: Atom PDF