scsi: fc_transport: docs: Add documentation for FC Remote Ports
authorAlok Tiwari <alok.a.tiwari@oracle.com>
Sat, 7 Jun 2025 16:22:56 +0000 (09:22 -0700)
committerMartin K. Petersen <martin.petersen@oracle.com>
Tue, 10 Jun 2025 01:49:26 +0000 (21:49 -0400)
commitc6503be73fa37034fac87c1ffed9f2a82adb5441
treee5794990ee9d93d30c07f8ac03854cac479e8005
parent8b0b14614c1566de7857d6ee29e27ec9ac740578
scsi: fc_transport: docs: Add documentation for FC Remote Ports

This patch updates the scsi_fc_transport.rst documentation by replacing
the outdated << To Be Supplied >> placeholder under the "FC Remote Ports
(rports)" section with a detailed explanation of remote port
functionality in the Fibre Channel (FC) transport class.

The new documentation covers:

 - What rports are and their role in FC-based SCSI communication

 - Their representation in sysfs (/sys/class/fc_remote_ports/)

 - Common sysfs attributes such as (port_id, port_name, node_name, and
   port_state).

 - Their typical lifecycle (creation and removal)

 - Guidance for driver developers on using fc_remote_port_add() and
   fc_remote_port_delete()

This change improves the completeness and usefulness of the FC transport
documentation for developers and users interacting with Fibre Channel
drivers in the Linux SCSI subsystem

Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
Link: https://lore.kernel.org/r/20250607162304.1765430-1-alok.a.tiwari@oracle.com
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Documentation/scsi/scsi_fc_transport.rst