Commit dacd4fa3 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] V4L2 Spec: improve the G/S_INPUT/OUTPUT documentation 



As Rupert pointed out, the phrase "It is good practice" should be replaced
with "You must".

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Cc: Rupert Eibauer <Rupert.Eibauer@ces.ch>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 6055b12a

Documentation/DocBook/media/v4l/vidioc-g-input.xml

+2 −2
Original line number Diff line number Diff line
@@ -61,8 +61,8 @@ desired input in an integer and call the 
<constant>VIDIOC_S_INPUT</constant> ioctl with a pointer to this

integer. Side effects are possible. For example inputs may support

different video standards, so the driver may implicitly switch the

current standard. It is good practice to select an input before

querying or negotiating any other parameters.</para>

current standard. Because of these possible side effects applications

must select an input before querying or negotiating any other parameters.</para>



    <para>Information about video inputs is available using the

&VIDIOC-ENUMINPUT; ioctl.</para>

Documentation/DocBook/media/v4l/vidioc-g-output.xml

+3 −2
Original line number Diff line number Diff line
@@ -61,8 +61,9 @@ desired output in an integer and call the 
<constant>VIDIOC_S_OUTPUT</constant> ioctl with a pointer to this integer.

Side effects are possible. For example outputs may support different

video standards, so the driver may implicitly switch the current

standard. It is good practice to select an output before querying or

negotiating any other parameters.</para>

standard.

standard. Because of these possible side effects applications

must select an output before querying or negotiating any other parameters.</para>



    <para>Information about video outputs is available using the

&VIDIOC-ENUMOUTPUT; ioctl.</para>