History

[media] DocBook: document DVB-S2 pilot in a table

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.

Mauro Carvalho Chehab committed 11 years ago

Commit 448bac11 parent 8092cd72 files · +28 −9Browse files

Unified · Split

2 files
  1. Documentation/DocBook/media/dvb/dvbproperty.xml +24 −7
  2. include/uapi/linux/dvb/frontend.h +4 −2
Documentation/DocBook/media/dvb/dvbproperty.xml+24−7
@@ -417,13 +417,30 @@ get/set up to 64 properties. The actual meaning of each property is described on · 416 unmodified lines
417417 <para>Sets DVB-S2 pilot</para>
418418 <section id="fe-pilot-t">
419419 <title>fe_pilot type</title>
420− <programlisting>
421−typedef enum fe_pilot {
422− PILOT_ON,
423− PILOT_OFF,
424− PILOT_AUTO,
425−} fe_pilot_t;
426− </programlisting>
420+<table pgwide="1" frame="none" id="fe-pilot">
421+ <title>enum fe_pilot</title>
422+ <tgroup cols="2">
423+ &cs-def;
424+ <thead>
425+ <row>
426+ <entry>ID</entry>
427+ <entry>Description</entry>
428+ </row>
429+ </thead>
430+ <tbody valign="top">
431+ <row>
432+ <entry align="char" id="PILOT-ON"><constant>PILOT_ON</constant></entry>
433+ <entry align="char">Pilot tones enabled</entry>
434+ </row><row>
435+ <entry align="char" id="PILOT-OFF"><constant>PILOT_OFF</constant></entry>
436+ <entry align="char">Pilot tones disabled</entry>
437+ </row><row>
438+ <entry align="char" id="PILOT-AUTO"><constant>PILOT_AUTO</constant></entry>
439+ <entry align="char">Autodetect pilot tones</entry>
440+ </row>
441+ </tbody>
442+ </tgroup>
443+</table>
427444 </section>
428445 </section>
429446 <section id="DTV-ROLLOFF">
include/uapi/linux/dvb/frontend.h+4−2
@@ -399,11 +399,13 @@ struct dvb_frontend_event { · 398 unmodified lines
399399
400400 #define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
401401
402−typedef enum fe_pilot {
402+enum fe_pilot {
403403 PILOT_ON,
404404 PILOT_OFF,
405405 PILOT_AUTO,
406−} fe_pilot_t;
406+};
407+
408+typedef enum fe_pilot fe_pilot_t;
407409
408410 typedef enum fe_rolloff {
409411 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */