Skip to content

Commit defb754

Browse files
rddunlapmartinkpetersen
authored andcommitted
scsi: driver-api: documentation: Change what is added to docbook
For scsi_devinfo.c, use :export: so that exported symbols are put into the docbook. Drop :internal: -- they aren't needed in the docbook. For scsi_proc.c, drop :internal:. This will cause all documented private (as is already done) and exported symbols to be added to the docbook. For scsi_scan.c, switch from :internal: to :export: so that exported symbols are put into the generated docbook. Signed-off-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Cc: James E.J. Bottomley <[email protected]> Cc: Martin K. Petersen <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Martin K. Petersen <[email protected]>
1 parent d4842e5 commit defb754

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

Documentation/driver-api/scsi.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Manage scsi_dev_info_list, which tracks blacklisted and whitelisted
126126
devices.
127127

128128
.. kernel-doc:: drivers/scsi/scsi_devinfo.c
129-
:internal:
129+
:export:
130130

131131
drivers/scsi/scsi_ioctl.c
132132
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -162,7 +162,6 @@ statistics and to pass information directly to the lowlevel driver. I.E.
162162
plumbing to manage /proc/scsi/\*
163163

164164
.. kernel-doc:: drivers/scsi/scsi_proc.c
165-
:internal:
166165

167166
drivers/scsi/scsi_netlink.c
168167
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -193,7 +192,7 @@ else, sequentially scan LUNs up until some maximum is reached, or a LUN
193192
is seen that cannot have a device attached to it.
194193

195194
.. kernel-doc:: drivers/scsi/scsi_scan.c
196-
:internal:
195+
:export:
197196

198197
drivers/scsi/scsi_sysctl.c
199198
~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)