linux/Documentation/scsi
Alok Tiwari c6503be73f 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>
2025-06-09 21:49:26 -04:00
..
scsi_transport_srp
53c700.rst
aacraid.rst
advansys.rst
aha152x.rst
aic7xxx.rst
aic79xx.rst
arcmsr_spec.rst scsi: docs: arcmsr: Use a chapter heading for clarity 2023-05-22 18:36:07 -04:00
bfa.rst
bnx2fc.rst
BusLogic.rst Buslogic: remove ISA support 2021-04-06 09:28:17 -06:00
ChangeLog.arcmsr
ChangeLog.ips
ChangeLog.lpfc Documentation: Fix typos 2023-08-18 11:29:03 -06:00
ChangeLog.megaraid scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
ChangeLog.megaraid_sas scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
ChangeLog.ncr53c8xx scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
ChangeLog.sym53c8xx scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
ChangeLog.sym53c8xx_2 scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
cxgb3i.rst
dc395x.rst scsi: docs: dc395x: Shorten the chapter heading 2023-05-22 18:36:07 -04:00
dpti.rst
FlashPoint.rst
g_NCR5380.rst scsi: docs: g_NCR5380: Shorten chapter heading 2023-05-22 18:36:07 -04:00
hpsa.rst
hptiop.rst
index.rst scsi: docs: Organize the SCSI documentation 2023-05-22 18:36:06 -04:00
libsas.rst scsi: libsas: Delete lldd_clear_aca callback 2022-02-19 15:59:34 -05:00
LICENSE.FlashPoint
link_power_management_policy.rst
lpfc.rst
megaraid.rst scsi: docs: megaraid: Clarify chapter heading 2023-05-22 18:36:07 -04:00
ncr53c8xx.rst scsi: docs: ncr53c8xx: Shorten chapter heading 2023-05-22 18:36:07 -04:00
NinjaSCSI.rst
ppa.rst
qlogicfas.rst
scsi-changer.rst scsi: docs: scsi-changer: Shorten the chapter heading 2023-05-22 18:36:07 -04:00
scsi-generic.rst scsi: docs: scsi-generic: Multiple cleanups 2023-05-22 18:36:07 -04:00
scsi-parameters.rst SCSI misc on 20210219 2021-02-22 10:24:58 -08:00
scsi.rst scsi: docs: introduction: Multiple cleanups 2023-05-22 18:36:07 -04:00
scsi_eh.rst scsi: documentation: scsi_eh: updates for EH changes 2025-01-02 13:10:54 -05:00
scsi_fc_transport.rst scsi: fc_transport: docs: Add documentation for FC Remote Ports 2025-06-09 21:49:26 -04:00
scsi_mid_low_api.rst scsi: docs: Clean up some style in scsi_mid_low_api 2025-05-12 22:11:55 -04:00
sd-parameters.rst
smartpqi.rst
st.rst scsi: st: Add sysfs file position_lost_in_reset 2025-02-03 17:51:31 -05:00
sym53c8xx_2.rst scsi: docs: sym53c8xx_2: Shorten chapter heading 2023-05-22 18:36:07 -04:00
sym53c500_cs.rst
tcm_qla2xxx.rst scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
ufs.rst scsi: Documentation: Correct spelling 2023-02-08 18:49:48 -05:00
wd719x.rst