[media] DocBook: document DVB-S2 pilot in a table
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sun, 7 Jun 2015 14:18:16 +0000 (11:18 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 9 Jun 2015 20:47:33 +0000 (17:47 -0300)
Putting it into a table allows to comment each possible
values, with makes more clear what field means.

Also, it allows to do cross-references with the frontend.h.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/dvb/dvbproperty.xml
include/uapi/linux/dvb/frontend.h

index 8d57f0c9b6aa30832e5fb32db3982a4f86a37eaa..e31d9457671fc687fc685f5abca568132bc91939 100644 (file)
@@ -417,13 +417,30 @@ get/set up to 64 properties. The actual meaning of each property is described on
        <para>Sets DVB-S2 pilot</para>
        <section id="fe-pilot-t">
                <title>fe_pilot type</title>
-               <programlisting>
-typedef enum fe_pilot {
-       PILOT_ON,
-       PILOT_OFF,
-       PILOT_AUTO,
-} fe_pilot_t;
-               </programlisting>
+<table pgwide="1" frame="none" id="fe-pilot">
+    <title>enum fe_pilot</title>
+    <tgroup cols="2">
+       &cs-def;
+       <thead>
+       <row>
+           <entry>ID</entry>
+           <entry>Description</entry>
+       </row>
+       </thead>
+       <tbody valign="top">
+       <row>
+           <entry align="char" id="PILOT-ON"><constant>PILOT_ON</constant></entry>
+           <entry align="char">Pilot tones enabled</entry>
+       </row><row>
+           <entry align="char" id="PILOT-OFF"><constant>PILOT_OFF</constant></entry>
+           <entry align="char">Pilot tones disabled</entry>
+       </row><row>
+           <entry align="char" id="PILOT-AUTO"><constant>PILOT_AUTO</constant></entry>
+           <entry align="char">Autodetect pilot tones</entry>
+       </row>
+        </tbody>
+    </tgroup>
+</table>
                </section>
        </section>
        <section id="DTV-ROLLOFF">
index 3a7ff9002654e12d3f03ebfe2af77aa2f75a4bb2..bb222eb04627143c87868df05c6d5a52337da1e9 100644 (file)
@@ -399,11 +399,13 @@ struct dvb_frontend_event {
 
 #define DTV_MAX_COMMAND                DTV_STAT_TOTAL_BLOCK_COUNT
 
-typedef enum fe_pilot {
+enum fe_pilot {
        PILOT_ON,
        PILOT_OFF,
        PILOT_AUTO,
-} fe_pilot_t;
+};
+
+typedef enum fe_pilot fe_pilot_t;
 
 typedef enum fe_rolloff {
        ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */