History

[media] DocBook: better document the DVB-S2 rolloff factor

Instead of using a program listing, use a table and make clearer what each define means.

Mauro Carvalho Chehab committed 11 years ago

Commit b35f6ba1 parent ff505742 files · +31 −10Browse files

Unified · Split

2 files
  1. Documentation/DocBook/media/dvb/dvbproperty.xml +27 −8
  2. include/uapi/linux/dvb/frontend.h +4 −2
Documentation/DocBook/media/dvb/dvbproperty.xml+27−8
@@ -468,14 +468,33 @@ get/set up to 64 properties. The actual meaning of each property is described on · 467 unmodified lines
468468
469469 <section id="fe-rolloff-t">
470470 <title>fe_rolloff type</title>
471− <programlisting>
472−typedef enum fe_rolloff {
473− ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
474− ROLLOFF_20,
475− ROLLOFF_25,
476− ROLLOFF_AUTO,
477−} fe_rolloff_t;
478− </programlisting>
471+<table pgwide="1" frame="none" id="fe-rolloff">
472+ <title>enum fe_rolloff</title>
473+ <tgroup cols="2">
474+ &cs-def;
475+ <thead>
476+ <row>
477+ <entry>ID</entry>
478+ <entry>Description</entry>
479+ </row>
480+ </thead>
481+ <tbody valign="top">
482+ <row>
483+ <entry align="char" id="ROLLOFF-35"><constant>ROLLOFF_35</constant></entry>
484+ <entry align="char">Roloff factor: &alpha;=35%</entry>
485+ </row><row>
486+ <entry align="char" id="ROLLOFF-20"><constant>ROLLOFF_20</constant></entry>
487+ <entry align="char">Roloff factor: &alpha;=20%</entry>
488+ </row><row>
489+ <entry align="char" id="ROLLOFF-25"><constant>ROLLOFF_25</constant></entry>
490+ <entry align="char">Roloff factor: &alpha;=25%</entry>
491+ </row><row>
492+ <entry align="char" id="ROLLOFF-AUTO"><constant>ROLLOFF_AUTO</constant></entry>
493+ <entry align="char">Auto-detect the roloff factor.</entry>
494+ </row>
495+ </tbody>
496+ </tgroup>
497+</table>
479498 </section>
480499 </section>
481500 <section id="DTV-DISEQC-SLAVE-REPLY">
include/uapi/linux/dvb/frontend.h+4−2
@@ -407,12 +407,14 @@ enum fe_pilot { · 406 unmodified lines
407407
408408 typedef enum fe_pilot fe_pilot_t;
409409
410−typedef enum fe_rolloff {
410+enum fe_rolloff {
411411 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
412412 ROLLOFF_20,
413413 ROLLOFF_25,
414414 ROLLOFF_AUTO,
415−} fe_rolloff_t;
415+};
416+
417+typedef enum fe_rolloff fe_rolloff_t;
416418
417419 typedef enum fe_delivery_system {
418420 SYS_UNDEFINED,