path: root/Documentation/scsi/scsi_mid_low_api.txt
diff options
authorLinus Torvalds <torvalds@linux-foundation.org>2017-12-04 13:55:28 -0800
committerLinus Torvalds <torvalds@linux-foundation.org>2017-12-04 13:55:28 -0800
commitfd6d2e506ce6f850d45342a15c896591291b77b5 (patch)
treeb44c6685a0bfa44dd08836985bfb76b5a87fc592 /Documentation/scsi/scsi_mid_low_api.txt
parent2391f0b4808e3d5af348324d69f5f45c56a26836 (diff)
parent9956cfef3409177d9e24ea4b7910148a18073a6f (diff)
Merge tag 'docs-4.15-fixes' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "A handful of documentation fixes. The most significant of these addresses a problem with the new warning mode: it can break the build when confronted with a source file containing malformed kerneldoc comments" * tag 'docs-4.15-fixes' of git://git.lwn.net/linux: Documentation: fix docs build error after source file removed scsi: documentation: Fix case of 'scsi_device' struct mention(s) genericirq.rst: Remove :c:func:`...` in code blocks dmaengine: doc : Fix warning "Title underline too short" while make xmldocs scripts/kernel-doc: Don't fail with status != 0 if error encountered with -none
Diffstat (limited to 'Documentation/scsi/scsi_mid_low_api.txt')
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/scsi/scsi_mid_low_api.txt b/Documentation/scsi/scsi_mid_low_api.txt
index 6338400eed73..2c31d9ee6776 100644
--- a/Documentation/scsi/scsi_mid_low_api.txt
+++ b/Documentation/scsi/scsi_mid_low_api.txt
@@ -319,12 +319,12 @@ struct Scsi_Host:
instance. If the reference count reaches 0 then the given instance
is freed
-The Scsi_device structure has had reference counting infrastructure added.
-This effectively spreads the ownership of struct Scsi_device instances
+The scsi_device structure has had reference counting infrastructure added.
+This effectively spreads the ownership of struct scsi_device instances
across the various SCSI layers which use them. Previously such instances
were exclusively owned by the mid level. See the access functions declared
towards the end of include/scsi/scsi_device.h . If an LLD wants to keep
-a copy of a pointer to a Scsi_device instance it should use scsi_device_get()
+a copy of a pointer to a scsi_device instance it should use scsi_device_get()
to bump its reference count. When it is finished with the pointer it can
use scsi_device_put() to decrement its reference count (and potentially
delete it).