summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/v4l/cec-func-close.xml
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-27 11:32:31 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-29 01:08:19 +0200
commit43f71d93a0cb342f0c918fba3f6abb7661e40ad2 (patch)
treea1dc7288bc480e7027ca1827ca4876472fa12e40 /Documentation/DocBook/media/v4l/cec-func-close.xml
parentMerge tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mch... (diff)
downloadlinux-43f71d93a0cb342f0c918fba3f6abb7661e40ad2.tar.xz
linux-43f71d93a0cb342f0c918fba3f6abb7661e40ad2.zip
doc-rst: Remove the media docbook
Now that all media documentation was converted to Sphinx, we should get rid of the old DocBook one, as we don't want people to submit patches against the old stuff. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/DocBook/media/v4l/cec-func-close.xml')
-rw-r--r--Documentation/DocBook/media/v4l/cec-func-close.xml64
1 files changed, 0 insertions, 64 deletions
diff --git a/Documentation/DocBook/media/v4l/cec-func-close.xml b/Documentation/DocBook/media/v4l/cec-func-close.xml
deleted file mode 100644
index 0812c8cd9634..000000000000
--- a/Documentation/DocBook/media/v4l/cec-func-close.xml
+++ /dev/null
@@ -1,64 +0,0 @@
-<refentry id="cec-func-close">
- <refmeta>
- <refentrytitle>cec close()</refentrytitle>
- &manvol;
- </refmeta>
-
- <refnamediv>
- <refname>cec-close</refname>
- <refpurpose>Close a cec device</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>#include &lt;unistd.h&gt;</funcsynopsisinfo>
- <funcprototype>
- <funcdef>int <function>close</function></funcdef>
- <paramdef>int <parameter>fd</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Arguments</title>
-
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter></term>
- <listitem>
- <para>&fd;</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>
- Note: this documents the proposed CEC API. This API is not yet finalized and
- is currently only available as a staging kernel module.
- </para>
-
- <para>Closes the cec device. Resources associated with the file descriptor
- are freed. The device configuration remain unchanged.</para>
- </refsect1>
-
- <refsect1>
- <title>Return Value</title>
-
- <para><function>close</function> returns 0 on success. On error, -1 is
- returned, and <varname>errno</varname> is set appropriately. Possible error
- codes are:</para>
-
- <variablelist>
- <varlistentry>
- <term><errorcode>EBADF</errorcode></term>
- <listitem>
- <para><parameter>fd</parameter> is not a valid open file descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-</refentry>