[media] DocBook: better document the DVB-S2 rolloff factor
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sun, 7 Jun 2015 14:59:27 +0000 (11:59 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 9 Jun 2015 20:47:34 +0000 (17:47 -0300)
Instead of using a program listing, use a table and make clearer
what each define means.

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

index e1d1e2469029f158adc16b8efb279c257c42aeb4..c0aa1ad9eccf9af2761f8de25e7bff0d93638681 100644 (file)
@@ -468,14 +468,33 @@ get/set up to 64 properties. The actual meaning of each property is described on
 
        <section id="fe-rolloff-t">
                <title>fe_rolloff type</title>
-               <programlisting>
-typedef enum fe_rolloff {
-       ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
-       ROLLOFF_20,
-       ROLLOFF_25,
-       ROLLOFF_AUTO,
-} fe_rolloff_t;
-               </programlisting>
+<table pgwide="1" frame="none" id="fe-rolloff">
+    <title>enum fe_rolloff</title>
+    <tgroup cols="2">
+       &cs-def;
+       <thead>
+       <row>
+           <entry>ID</entry>
+           <entry>Description</entry>
+       </row>
+       </thead>
+       <tbody valign="top">
+       <row>
+           <entry align="char" id="ROLLOFF-35"><constant>ROLLOFF_35</constant></entry>
+           <entry align="char">Roloff factor: &alpha;=35%</entry>
+       </row><row>
+           <entry align="char" id="ROLLOFF-20"><constant>ROLLOFF_20</constant></entry>
+           <entry align="char">Roloff factor: &alpha;=20%</entry>
+       </row><row>
+           <entry align="char" id="ROLLOFF-25"><constant>ROLLOFF_25</constant></entry>
+           <entry align="char">Roloff factor: &alpha;=25%</entry>
+       </row><row>
+           <entry align="char" id="ROLLOFF-AUTO"><constant>ROLLOFF_AUTO</constant></entry>
+           <entry align="char">Auto-detect the roloff factor.</entry>
+       </row>
+        </tbody>
+    </tgroup>
+</table>
                </section>
        </section>
        <section id="DTV-DISEQC-SLAVE-REPLY">
index bb222eb04627143c87868df05c6d5a52337da1e9..cdd9e2fc030d979c8f8f4b7bb96ad792c30d5edc 100644 (file)
@@ -407,12 +407,14 @@ enum fe_pilot {
 
 typedef enum fe_pilot fe_pilot_t;
 
-typedef enum fe_rolloff {
+enum fe_rolloff {
        ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
        ROLLOFF_20,
        ROLLOFF_25,
        ROLLOFF_AUTO,
-} fe_rolloff_t;
+};
+
+typedef enum fe_rolloff fe_rolloff_t;
 
 typedef enum fe_delivery_system {
        SYS_UNDEFINED,