All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 29/35] DocBook: better document FE_DISEQC_RESET_OVERLOAD
Date: Thu, 28 May 2015 18:49:32 -0300	[thread overview]
Message-ID: <eef99691e0f7d4869ff8932cc5e0dccccac57878.1432844837.git.mchehab@osg.samsung.com> (raw)
In-Reply-To: <cover.1432844837.git.mchehab@osg.samsung.com>
In-Reply-To: <cover.1432844837.git.mchehab@osg.samsung.com>

Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

 create mode 100644 Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml

diff --git a/Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml b/Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml
new file mode 100644
index 000000000000..c104df77ecd0
--- /dev/null
+++ b/Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml
@@ -0,0 +1,51 @@
+<refentry id="FE_DISEQC_RESET_OVERLOAD">
+  <refmeta>
+    <refentrytitle>ioctl FE_DISEQC_RESET_OVERLOAD</refentrytitle>
+    &manvol;
+  </refmeta>
+
+  <refnamediv>
+    <refname>FE_DISEQC_RESET_OVERLOAD</refname>
+    <refpurpose>Restores the power to the antenna subsystem, if it was powered
+	off due to power overload.</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcprototype>
+	<funcdef>int <function>ioctl</function></funcdef>
+	<paramdef>int <parameter>fd</parameter></paramdef>
+	<paramdef>int <parameter>request</parameter></paramdef>
+	<paramdef>NULL</paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Arguments</title>
+        <variablelist>
+      <varlistentry>
+	<term><parameter>fd</parameter></term>
+	<listitem>
+	  <para>&fe_fd;</para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term><parameter>request</parameter></term>
+	<listitem>
+	  <para>FE_DISEQC_RESET_OVERLOAD</para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>If the bus has been automatically powered off due to power overload, this ioctl
+ call restores the power to the bus. The call requires read/write access to the
+ device. This call has no effect if the device is manually powered off. Not all
+ DVB adapters support this ioctl.</para>
+&return-value-dvb;
+</refsect1>
+</refentry>
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index f7bb2db07c23..86bd9ed9d7f8 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -333,50 +333,7 @@ typedef enum fe_hierarchy {
  </row></tbody></tgroup></informaltable>
 </section>
 
-
-<section id="FE_DISEQC_RESET_OVERLOAD">
-<title>FE_DISEQC_RESET_OVERLOAD</title>
-<para>DESCRIPTION
-</para>
-<informaltable><tgroup cols="1"><tbody><row><entry
- align="char">
-<para>If the bus has been automatically powered off due to power overload, this ioctl
- call restores the power to the bus. The call requires read/write access to the
- device. This call has no effect if the device is manually powered off. Not all
- DVB adapters support this ioctl.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-
-<para>SYNOPSIS
-</para>
-<informaltable><tgroup cols="1"><tbody><row><entry
- align="char">
-<para>int ioctl(int fd, int request =
- <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>PARAMETERS
-</para>
-<informaltable><tgroup cols="2"><tbody><row><entry
- align="char">
-<para>int fd</para>
-</entry><entry
- align="char">
-<para>File descriptor returned by a previous call to open().</para>
-</entry>
- </row><row><entry
- align="char">
-<para>int request</para>
-</entry><entry
- align="char">
-<para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
- command.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-
-&return-value-dvb;
-</section>
-
+&sub-fe-diseqc-reset-overload;
 &sub-fe-diseqc-send-master-cmd;
 &sub-fe-diseqc-recv-slave-reply;
 &sub-fe-diseqc-send-burst;
-- 
2.4.1


  parent reply	other threads:[~2015-05-28 21:49 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-28 21:49 [PATCH 00/35] Improve DVB frontend API documentation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 01/35] DocBook: Update DVB supported standards at introduction Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 02/35] DocBook: add a note about the ALSA API Mauro Carvalho Chehab
2015-06-02  2:50   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 03/35] DocBook: add drawing with a typical media device Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 04/35] DocBook: fix emphasis at the DVB documentation Mauro Carvalho Chehab
2015-06-02  2:56   ` Jonathan Corbet
2015-06-02 11:51     ` Mauro Carvalho Chehab
2015-06-02 13:02       ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 05/35] DocBook: Improve DVB frontend description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 06/35] DocBook: move DVBv3 frontend bits to a separate section Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 07/35] dvb: split enum from typedefs at frontend.h Mauro Carvalho Chehab
2015-05-28 21:57   ` Hans Verkuil
2015-05-28 21:57     ` Hans Verkuil
2015-05-28 22:22     ` Mauro Carvalho Chehab
2015-05-28 22:22       ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 08/35] DocBook: reformat FE_GET_INFO ioctl documentation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 09/35] DocBook: move FE_GET_INFO to a separate xml file Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 10/35] DocBook: improve documentation for FE_READ_STATUS Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 11/35] DocBook: move DVB properties to happen earlier at the document Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 12/35] DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std way Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 13/35] DocBook: fix xref to the FE open() function Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 14/35] DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 15/35] DocBook: Improve the description of the properties API Mauro Carvalho Chehab
2015-06-02  3:03   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 16/35] DocBook: Add xref links for DTV propeties Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 17/35] DocBook: Improve xref check for undocumented ioctls Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 18/35] DocBook: remove duplicated ioctl from v4l2-subdev Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 19/35] DocBook: Fix false positive undefined ioctl references Mauro Carvalho Chehab
2015-05-30 12:20   ` Hans Verkuil
2015-05-28 21:49 ` [PATCH 20/35] DocBook: Rename ioctl xml files Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 21/35] DocBook: move FE_GET_PROPERTY to its own xml file Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 22/35] DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 23/35] DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 24/35] DocBook: better document FE_SET_VOLTAGE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 25/35] DocBook: better document FE_SET_TONE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 26/35] DocBook: better document FE_DISEQC_SEND_BURST ioctl Mauro Carvalho Chehab
2015-05-28 21:49   ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 27/35] DocBook: better document FE_DISEQC_RECV_SLAVE_REPLY Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 28/35] DocBook: better document FE_DISEQC_SEND_MASTER_CMD Mauro Carvalho Chehab
2015-05-28 21:49 ` Mauro Carvalho Chehab [this message]
2015-05-28 21:49 ` [PATCH 30/35] DocBook: better organize the function descriptions for frontend Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 31/35] DocBook: fix FE_READ_STATUS argument description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 32/35] DocBook: Provide a high-level description for DVB frontend Mauro Carvalho Chehab
2015-06-02  3:08   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 33/35] DocBook: add a proper description for dvb_frontend_info.fe_type Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 34/35] DocBook: Better document enum fe_modulation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 35/35] DocBook: some fixes at FE_GET_INFO Mauro Carvalho Chehab
2015-06-02  3:12 ` [PATCH 00/35] Improve DVB frontend API documentation Jonathan Corbet
2015-06-02  9:26   ` Mauro Carvalho Chehab
2015-06-02  9:33     ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=eef99691e0f7d4869ff8932cc5e0dccccac57878.1432844837.git.mchehab@osg.samsung.com \
    --to=mchehab@osg.samsung.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.