| Message ID | 20241218000748.932850-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers | show |
| Series | scsi: driver-api documentation: change what is added to docbook | expand |
Randy, > 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. Applied to 6.14/scsi-staging, thanks!
On Tue, 17 Dec 2024 16:07:48 -0800, Randy Dunlap wrote: > 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. > > [...] Applied to 6.14/scsi-queue, thanks! [1/1] scsi: driver-api documentation: change what is added to docbook https://git.kernel.org/mkp/scsi/c/defb7541dac0
--- linux-next-20241212.orig/Documentation/driver-api/scsi.rst +++ linux-next-20241212/Documentation/driver-api/scsi.rst @@ -126,7 +126,7 @@ Manage scsi_dev_info_list, which tracks devices. .. kernel-doc:: drivers/scsi/scsi_devinfo.c - :internal: + :export: drivers/scsi/scsi_ioctl.c ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -162,7 +162,6 @@ statistics and to pass information direc plumbing to manage /proc/scsi/\* .. kernel-doc:: drivers/scsi/scsi_proc.c - :internal: drivers/scsi/scsi_netlink.c ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -193,7 +192,7 @@ else, sequentially scan LUNs up until so is seen that cannot have a device attached to it. .. kernel-doc:: drivers/scsi/scsi_scan.c - :internal: + :export: drivers/scsi/scsi_sysctl.c ~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <rdunlap@infradead.org> Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com> Cc: "Martin K. Petersen" <martin.petersen@oracle.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org --- Documentation/driver-api/scsi.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)