kernel-fxtec-pro1x/Documentation/DocBook/media/v4l/vidioc-log-status.xml
Mauro Carvalho Chehab 4266129964 [media] DocBook: Move all media docbook stuff into its own directory
This patch addresses several issues pointed by Randy Dunlap
<rdunlap@xenotime.net> at changeset ece722c:

- In the generated index.html file, "media" is listed first, but it
  should be listed in alphabetical order, not first.

- The generated files are (hidden) in .tmpmedia/

- The link from the top-level index.html file to "media" is to
  media/index.html, but the file is actually in .tmpmedia/media/index.html

- Please build docs with and without using "O=builddir" and test that.

- Would it be possible for media to have its own Makefile instead of
  merging into this one?

Due to the way cleandocs target works, I had to rename the media DocBook
to media_api, otherwise cleandocs would remove the /media directory.

Thanks-to: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
2011-07-27 17:52:05 -03:00

58 lines
1.5 KiB
XML

<refentry id="vidioc-log-status">
<refmeta>
<refentrytitle>ioctl VIDIOC_LOG_STATUS</refentrytitle>
&manvol;
</refmeta>
<refnamediv>
<refname>VIDIOC_LOG_STATUS</refname>
<refpurpose>Log driver status information</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>As the video/audio devices become more complicated it
becomes harder to debug problems. When this ioctl is called the driver
will output the current device status to the kernel log. This is
particular useful when dealing with problems like no sound, no video
and incorrectly tuned channels. Also many modern devices autodetect
video and audio standards and this ioctl will report what the device
thinks what the standard is. Mismatches may give an indication where
the problem is.</para>
<para>This ioctl is optional and not all drivers support it. It
was introduced in Linux 2.6.15.</para>
</refsect1>
<refsect1>
&return-value;
<variablelist>
<varlistentry>
<term><errorcode>EINVAL</errorcode></term>
<listitem>
<para>The driver does not support this ioctl.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--
Local Variables:
mode: sgml
sgml-parent-document: "v4l2.sgml"
indent-tabs-mode: nil
End:
-->