aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2012-01-11 05:37:54 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-01-16 06:38:29 -0500
commitdacd4fa37dbafe209a90d6d5b729d2257df4b734 (patch)
treeed3b9519c1013cafb6c9da63299806910c25c5fd
parent6055b12ae0f433314cba98f423fb8c5fc211ca8d (diff)
[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: Hans Verkuil <hans.verkuil@cisco.com> Cc: Rupert Eibauer <Rupert.Eibauer@ces.ch> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-g-input.xml4
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-g-output.xml5
2 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-input.xml b/Documentation/DocBook/media/v4l/vidioc-g-input.xml
index 08ae82f131f2..1d43065090dd 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-input.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-input.xml
@@ -61,8 +61,8 @@ desired input in an integer and call the
61<constant>VIDIOC_S_INPUT</constant> ioctl with a pointer to this 61<constant>VIDIOC_S_INPUT</constant> ioctl with a pointer to this
62integer. Side effects are possible. For example inputs may support 62integer. Side effects are possible. For example inputs may support
63different video standards, so the driver may implicitly switch the 63different video standards, so the driver may implicitly switch the
64current standard. It is good practice to select an input before 64current standard. Because of these possible side effects applications
65querying or negotiating any other parameters.</para> 65must select an input before querying or negotiating any other parameters.</para>
66 66
67 <para>Information about video inputs is available using the 67 <para>Information about video inputs is available using the
68&VIDIOC-ENUMINPUT; ioctl.</para> 68&VIDIOC-ENUMINPUT; ioctl.</para>
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-output.xml b/Documentation/DocBook/media/v4l/vidioc-g-output.xml
index fd45f1c13ccf..4533068ecb8a 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-output.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-output.xml
@@ -61,8 +61,9 @@ desired output in an integer and call the
61<constant>VIDIOC_S_OUTPUT</constant> ioctl with a pointer to this integer. 61<constant>VIDIOC_S_OUTPUT</constant> ioctl with a pointer to this integer.
62Side effects are possible. For example outputs may support different 62Side effects are possible. For example outputs may support different
63video standards, so the driver may implicitly switch the current 63video standards, so the driver may implicitly switch the current
64standard. It is good practice to select an output before querying or 64standard.
65negotiating any other parameters.</para> 65standard. Because of these possible side effects applications
66must select an output before querying or negotiating any other parameters.</para>
66 67
67 <para>Information about video outputs is available using the 68 <para>Information about video outputs is available using the
68&VIDIOC-ENUMOUTPUT; ioctl.</para> 69&VIDIOC-ENUMOUTPUT; ioctl.</para>