Documentation/media: Remove incorrect statement

Message ID 20220422074024.1329082-1-dorota.czaplejewicz@puri.sm (mailing list archive)
State Accepted
Delegated to: Hans Verkuil
Headers
Series Documentation/media: Remove incorrect statement |

Commit Message

Dorota Czaplejewicz April 22, 2022, 7:50 a.m. UTC
  Signed-off-by: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
---
Hi,

I tried to debug streaming in libcamera, where I stumbled upon this. I asked around on IRC where I was told that this statement in the documentation is wrong, so I'm submitting a removal.

Cheers,
Dorota Czaplejewicz

 Documentation/userspace-api/media/v4l/vidioc-streamon.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
  

Comments

Hans Verkuil April 28, 2022, 6:50 a.m. UTC | #1
Hi Dorota,

On 22/04/2022 09:50, Dorota Czaplejewicz wrote:
> Signed-off-by: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
> ---
> Hi,
> 
> I tried to debug streaming in libcamera, where I stumbled upon this. I asked around on IRC where I was told that this statement in the documentation is wrong, so I'm submitting a removal.

For future reference: a patch needs to start with a commit message,
followed by your Signed-off-by, then '---' and the patch itself.

I've taking the paragraph above as the commit message, so no need for
you to do anything here.

Regards,

	Hans

> 
> Cheers,
> Dorota Czaplejewicz
> 
>  Documentation/userspace-api/media/v4l/vidioc-streamon.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/Documentation/userspace-api/media/v4l/vidioc-streamon.rst b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
> index 0bc86f06947b..1a79313a29fa 100644
> --- a/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
> +++ b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
> @@ -43,8 +43,7 @@ the capture or output process during streaming
>  Capture hardware is disabled and no input buffers are filled (if there
>  are any empty buffers in the incoming queue) until ``VIDIOC_STREAMON``
>  has been called. Output hardware is disabled and no video signal is
> -produced until ``VIDIOC_STREAMON`` has been called. The ioctl will
> -succeed when at least one output buffer is in the incoming queue.
> +produced until ``VIDIOC_STREAMON`` has been called.
>  
>  Memory-to-memory devices will not start until ``VIDIOC_STREAMON`` has
>  been called for both the capture and output stream types.
  

Patch

diff --git a/Documentation/userspace-api/media/v4l/vidioc-streamon.rst b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
index 0bc86f06947b..1a79313a29fa 100644
--- a/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
+++ b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst
@@ -43,8 +43,7 @@  the capture or output process during streaming
 Capture hardware is disabled and no input buffers are filled (if there
 are any empty buffers in the incoming queue) until ``VIDIOC_STREAMON``
 has been called. Output hardware is disabled and no video signal is
-produced until ``VIDIOC_STREAMON`` has been called. The ioctl will
-succeed when at least one output buffer is in the incoming queue.
+produced until ``VIDIOC_STREAMON`` has been called.
 
 Memory-to-memory devices will not start until ``VIDIOC_STREAMON`` has
 been called for both the capture and output stream types.