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
417 <para>Sets DVB-S2 pilot</para>417 <para>Sets DVB-S2 pilot</para>
418 <section id="fe-pilot-t">418 <section id="fe-pilot-t">
419 <title>fe_pilot type</title>419 <title>fe_pilot type</title>
420 <programlisting>420<table pgwide="1" frame="none" id="fe-pilot">
421typedef enum fe_pilot {421 <title>enum fe_pilot</title>
422 PILOT_ON,422 <tgroup cols="2">
423 PILOT_OFF,423 &cs-def;
424 PILOT_AUTO,424 <thead>
425} fe_pilot_t;425 <row>
426 </programlisting>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>
427 </section>444 </section>
428 </section>445 </section>
429 <section id="DTV-ROLLOFF">446 <section id="DTV-ROLLOFF">
include/uapi/linux/dvb/frontend.h+4−2
@@ -399,11 +399,13 @@ struct dvb_frontend_event { · 398 unmodified lines
399 399
400#define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT400#define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
401 401
402typedef enum fe_pilot {402enum fe_pilot {
403 PILOT_ON,403 PILOT_ON,
404 PILOT_OFF,404 PILOT_OFF,
405 PILOT_AUTO,405 PILOT_AUTO,
406} fe_pilot_t;406};
407
408typedef enum fe_pilot fe_pilot_t;
407 409
408typedef enum fe_rolloff {410typedef enum fe_rolloff {
409 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */411 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */