diff mbox series

Documentation: media: gen-errors.rst: fix confusing ENOTTY description

Message ID 34367590-d62a-4527-b31e-0401ba030ad4@xs4all.nl (mailing list archive)
State New, archived
Headers show
Series Documentation: media: gen-errors.rst: fix confusing ENOTTY description | expand

Commit Message

Hans Verkuil Oct. 6, 2023, 1:45 p.m. UTC
The text is very, very old and predates /dev/mediaX devices, so the
reference to "media device" is today very confusing.

It also says that the ioctl is not supported by the driver, but a
driver may have multiple device nodes, some support a given ioctl,
and some don't.

Simplify the description: ENOTTY means that the ioctl is not supported
by the file descriptor.

Reported-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
---

Comments

Nicolas Dufresne Oct. 6, 2023, 4:28 p.m. UTC | #1
Hi,

thanks for the quick adjustment.

Le vendredi 06 octobre 2023 à 15:45 +0200, Hans Verkuil a écrit :
> The text is very, very old and predates /dev/mediaX devices, so the
> reference to "media device" is today very confusing.
> 
> It also says that the ioctl is not supported by the driver, but a
> driver may have multiple device nodes, some support a given ioctl,
> and some don't.
> 
> Simplify the description: ENOTTY means that the ioctl is not supported
> by the file descriptor.
> 
> Reported-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

Reviewed-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>

> ---
> diff --git a/Documentation/userspace-api/media/gen-errors.rst b/Documentation/userspace-api/media/gen-errors.rst
> index e595d0bea109..4e8defd3612b 100644
> --- a/Documentation/userspace-api/media/gen-errors.rst
> +++ b/Documentation/userspace-api/media/gen-errors.rst
> @@ -59,9 +59,7 @@ Generic Error Codes
> 
>      -  -  ``ENOTTY``
> 
> -       -  The ioctl is not supported by the driver, actually meaning that
> -	  the required functionality is not available, or the file
> -	  descriptor is not for a media device.
> +       -  The ioctl is not supported by the file descriptor.
> 
>      -  -  ``ENOSPC``
>
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/gen-errors.rst b/Documentation/userspace-api/media/gen-errors.rst
index e595d0bea109..4e8defd3612b 100644
--- a/Documentation/userspace-api/media/gen-errors.rst
+++ b/Documentation/userspace-api/media/gen-errors.rst
@@ -59,9 +59,7 @@  Generic Error Codes

     -  -  ``ENOTTY``

-       -  The ioctl is not supported by the driver, actually meaning that
-	  the required functionality is not available, or the file
-	  descriptor is not for a media device.
+       -  The ioctl is not supported by the file descriptor.

     -  -  ``ENOSPC``