Skip to contentSkip to conversation

block: fix userspace documentation reference for del_gendisk()

PATCH Superseded Luis Chamberlain 2 participants 3 messages Nov 17, 2020 – Apr 23, 2021 Block layer

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: fix userspace documentation reference for del_gendisk()

Commit b5bd357cf8b ("block: add docs for gendisk / request_queue refcount helpers") has a typo where it references drivers for del_gendisk() when we instead meant userspace, as the reference is to the userspace experience. This fixes this.

---
 block/genhd.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
block/genhd.c +2 -2
index 0a273211fec2..9511620f558a 100644
@@ -880,8 +880,8 @@ static void invalidate_partition(struct gendisk *disk, int partno)
  * with put_disk(), which should be called after del_gendisk(), if
  * __device_add_disk() was used.
  *
- * Drivers exist which depend on the release of the gendisk to be synchronous,
- * it should not be deferred.
+ * Userspace may exist which depends on the release of the gendisk to be
+ * synchronous, it should not be deferred.
  *
  * Context: can sleep
  */
Signature · 1 line
2.28.0
#1 lore raw

*Poke*

This documentation fix is not merged yet.

Luis

Quoted 28 lines · Luis Chamberlain

Commit b5bd357cf8b ("block: add docs for gendisk / request_queue refcount helpers") has a typo where it references drivers for del_gendisk() when we instead meant userspace, as the reference is to the userspace experience. This fixes this.

---
 block/genhd.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
block/genhd.c +2 -2
index 0a273211fec2..9511620f558a 100644
@@ -880,8 +880,8 @@ static void invalidate_partition(struct gendisk *disk, int partno)
  * with put_disk(), which should be called after del_gendisk(), if
  * __device_add_disk() was used.
  *
- * Drivers exist which depend on the release of the gendisk to be synchronous,
- * it should not be deferred.
+ * Userspace may exist which depends on the release of the gendisk to be
+ * synchronous, it should not be deferred.
  *
  * Context: can sleep
  */
Signature · 1 line
2.28.0
#2 lore raw
In reply to Luis Chamberlain
Quoted 15 lines · Luis Chamberlain

Commit b5bd357cf8b ("block: add docs for gendisk / request_queue refcount helpers") has a typo where it references drivers for del_gendisk() when we instead meant userspace, as the reference is to the userspace experience. This fixes this.

---
 block/genhd.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
block/genhd.c +0 -0
index 0a273211fec2..9511620f558a 100644

block/genhd.c static void invalidate_partition(struct gendisk *disk, int partno) · line 884

Quoted 7 lines
block/genhd.c +2 -2
@@ -880,8 +880,8 @@ static void invalidate_partition(struct gendisk *disk, int partno)
  * with put_disk(), which should be called after del_gendisk(), if
  * __device_add_disk() was used.
  *
- * Drivers exist which depend on the release of the gendisk to be synchronous,
- * it should not be deferred.
+ * Userspace may exist which depends on the release of the gendisk to be
+ * synchronous, it should not be deferred.

Please change "may exist which depends" into "software may depend" to make the comment easier to understand.

Thanks,

Bart.