Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] DocBook: better document FE_DISEQC_RESET_OVERLOAD

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>

+52 -44
+51
Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml
··· 1 + <refentry id="FE_DISEQC_RESET_OVERLOAD"> 2 + <refmeta> 3 + <refentrytitle>ioctl FE_DISEQC_RESET_OVERLOAD</refentrytitle> 4 + &manvol; 5 + </refmeta> 6 + 7 + <refnamediv> 8 + <refname>FE_DISEQC_RESET_OVERLOAD</refname> 9 + <refpurpose>Restores the power to the antenna subsystem, if it was powered 10 + off due to power overload.</refpurpose> 11 + </refnamediv> 12 + 13 + <refsynopsisdiv> 14 + <funcsynopsis> 15 + <funcprototype> 16 + <funcdef>int <function>ioctl</function></funcdef> 17 + <paramdef>int <parameter>fd</parameter></paramdef> 18 + <paramdef>int <parameter>request</parameter></paramdef> 19 + <paramdef>NULL</paramdef> 20 + </funcprototype> 21 + </funcsynopsis> 22 + </refsynopsisdiv> 23 + 24 + <refsect1> 25 + <title>Arguments</title> 26 + <variablelist> 27 + <varlistentry> 28 + <term><parameter>fd</parameter></term> 29 + <listitem> 30 + <para>&fe_fd;</para> 31 + </listitem> 32 + </varlistentry> 33 + <varlistentry> 34 + <term><parameter>request</parameter></term> 35 + <listitem> 36 + <para>FE_DISEQC_RESET_OVERLOAD</para> 37 + </listitem> 38 + </varlistentry> 39 + </variablelist> 40 + </refsect1> 41 + 42 + <refsect1> 43 + <title>Description</title> 44 + 45 + <para>If the bus has been automatically powered off due to power overload, this ioctl 46 + call restores the power to the bus. The call requires read/write access to the 47 + device. This call has no effect if the device is manually powered off. Not all 48 + DVB adapters support this ioctl.</para> 49 + &return-value-dvb; 50 + </refsect1> 51 + </refentry>
+1 -44
Documentation/DocBook/media/dvb/frontend.xml
··· 333 333 </row></tbody></tgroup></informaltable> 334 334 </section> 335 335 336 - 337 - <section id="FE_DISEQC_RESET_OVERLOAD"> 338 - <title>FE_DISEQC_RESET_OVERLOAD</title> 339 - <para>DESCRIPTION 340 - </para> 341 - <informaltable><tgroup cols="1"><tbody><row><entry 342 - align="char"> 343 - <para>If the bus has been automatically powered off due to power overload, this ioctl 344 - call restores the power to the bus. The call requires read/write access to the 345 - device. This call has no effect if the device is manually powered off. Not all 346 - DVB adapters support this ioctl.</para> 347 - </entry> 348 - </row></tbody></tgroup></informaltable> 349 - 350 - <para>SYNOPSIS 351 - </para> 352 - <informaltable><tgroup cols="1"><tbody><row><entry 353 - align="char"> 354 - <para>int ioctl(int fd, int request = 355 - <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para> 356 - </entry> 357 - </row></tbody></tgroup></informaltable> 358 - <para>PARAMETERS 359 - </para> 360 - <informaltable><tgroup cols="2"><tbody><row><entry 361 - align="char"> 362 - <para>int fd</para> 363 - </entry><entry 364 - align="char"> 365 - <para>File descriptor returned by a previous call to open().</para> 366 - </entry> 367 - </row><row><entry 368 - align="char"> 369 - <para>int request</para> 370 - </entry><entry 371 - align="char"> 372 - <para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this 373 - command.</para> 374 - </entry> 375 - </row></tbody></tgroup></informaltable> 376 - 377 - &return-value-dvb; 378 - </section> 379 - 336 + &sub-fe-diseqc-reset-overload; 380 337 &sub-fe-diseqc-send-master-cmd; 381 338 &sub-fe-diseqc-recv-slave-reply; 382 339 &sub-fe-diseqc-send-burst;