Documentation/hdio: fix up obscure bd_contains references
authorChristoph Hellwig <hch@lst.de>
Thu, 3 Sep 2020 05:40:56 +0000 (07:40 +0200)
committerJens Axboe <axboe@kernel.dk>
Fri, 25 Sep 2020 14:18:57 +0000 (08:18 -0600)
bd_contains is an implementation detail and should not be mentioned in
a userspace API documentation.

Signed-off-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
Documentation/userspace-api/ioctl/hdio.rst

index e822e3d..817371b 100644 (file)
@@ -181,7 +181,7 @@ HDIO_SET_UNMASKINTR
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
@@ -231,7 +231,7 @@ HDIO_SET_MULTCOUNT
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range supported by disk.
          - EBUSY       Controller busy or blockmode already set.
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range supported by disk.
          - EBUSY       Controller busy or blockmode already set.
@@ -295,7 +295,7 @@ HDIO_GET_IDENTITY
                the ATA specification.
 
        error returns:
                the ATA specification.
 
        error returns:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - ENOMSG      IDENTIFY DEVICE information not available
 
        notes:
          - ENOMSG      IDENTIFY DEVICE information not available
 
        notes:
@@ -355,7 +355,7 @@ HDIO_SET_KEEPSETTINGS
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY               Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY               Controller busy
@@ -1055,7 +1055,7 @@ HDIO_SET_32BIT
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 3]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 3]
          - EBUSY       Controller busy
@@ -1085,7 +1085,7 @@ HDIO_SET_NOWERR
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY               Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY               Controller busy
@@ -1113,7 +1113,7 @@ HDIO_SET_DMA
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
@@ -1141,7 +1141,7 @@ HDIO_SET_PIO_MODE
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 255]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 255]
          - EBUSY       Controller busy
@@ -1237,7 +1237,7 @@ HDIO_SET_WCACHE
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
@@ -1265,7 +1265,7 @@ HDIO_SET_ACOUSTIC
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 254]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 254]
          - EBUSY       Controller busy
@@ -1305,7 +1305,7 @@ HDIO_SET_ADDRESS
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 2]
          - EBUSY               Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 2]
          - EBUSY               Controller busy
@@ -1331,7 +1331,7 @@ HDIO_SET_IDE_SCSI
 
 
        error return:
 
 
        error return:
-         - EINVAL      (bdev != bdev->bd_contains) (not sure what this means)
+         - EINVAL      Called on a partition instead of the whole disk device
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy
          - EACCES      Access denied:  requires CAP_SYS_ADMIN
          - EINVAL      value out of range [0 1]
          - EBUSY       Controller busy