Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9df4fc5b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: improve documentation for hierarchy 



Format it as a table and links it with the legacy API xml.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 903142e5

Documentation/DocBook/media/dvb/dvbproperty.xml

+37 −9
Original line number Diff line number Diff line
@@ -951,15 +951,43 @@ typedef enum atscmh_sccc_code_mode { 
	<section id="DTV-HIERARCHY">

	<title><constant>DTV_HIERARCHY</constant></title>

	<para>Frontend hierarchy</para>

	<programlisting>

typedef enum fe_hierarchy {

	 HIERARCHY_NONE,

	 HIERARCHY_1,

	 HIERARCHY_2,

	 HIERARCHY_4,

	 HIERARCHY_AUTO

 } fe_hierarchy_t;

	</programlisting>





<section id="fe-hierarchy-t">

<title>Frontend hierarchy</title>



<table pgwide="1" frame="none" id="fe-hierarchy">

    <title>enum fe_hierarchy</title>

    <tgroup cols="2">

	&cs-def;

	<thead>

	<row>

	    <entry>ID</entry>

	    <entry>Description</entry>

	</row>

	</thead>

	<tbody valign="top">

	<row>

	     <entry>HIERARCHY_NONE</entry>

	    <entry>No hierarchy</entry>

	</row><row>

	     <entry>HIERARCHY_AUTO</entry>

	    <entry>Autodetect hierarchy (if supported)</entry>

	</row><row>

	     <entry>HIERARCHY_1</entry>

	    <entry>Hierarchy 1</entry>

	</row><row>

	     <entry>HIERARCHY_2</entry>

	    <entry>Hierarchy 2</entry>

	</row><row>

	     <entry>HIERARCHY_4</entry>

	    <entry>Hierarchy 4</entry>

	</row>

        </tbody>

    </tgroup>

</table>

</section>



	</section>

	<section id="DTV-STREAM-ID">

	<title><constant>DTV_STREAM_ID</constant></title>

Documentation/DocBook/media/dvb/frontend.xml

+0 −18
Original line number Diff line number Diff line
@@ -56,24 +56,6 @@ specification is available at 


&sub-dvbproperty;



<section>

<title>More OFDM parameters</title>



<section id="fe-hierarchy-t">

<title>frontend hierarchy</title>

<programlisting>

typedef enum fe_hierarchy {

	 HIERARCHY_NONE,

	 HIERARCHY_1,

	 HIERARCHY_2,

	 HIERARCHY_4,

	 HIERARCHY_AUTO

 } fe_hierarchy_t;

</programlisting>

</section>



</section>



<section id="frontend_fcalls">

<title>Frontend Function Calls</title>

Documentation/DocBook/media/dvb/frontend_legacy_api.xml

+1 −1
Original line number Diff line number Diff line
@@ -183,7 +183,7 @@ struct dvb_vsb_parameters { 
	 &fe-modulation-t;     constellation; /&#x22C6; modulation type (see above) &#x22C6;/

	 &fe-transmit-mode-t;  transmission_mode;

	 &fe-guard-interval-t; guard_interval;

	 fe_hierarchy_t      hierarchy_information;

	 &fe-hierarchy-t;      hierarchy_information;

 };

</programlisting>

</section>

include/uapi/linux/dvb/frontend.h

+4 −2
Original line number Diff line number Diff line
@@ -244,13 +244,15 @@ enum fe_guard_interval { 


typedef enum fe_guard_interval fe_guard_interval_t;



typedef enum fe_hierarchy {

enum fe_hierarchy {

	HIERARCHY_NONE,

	HIERARCHY_1,

	HIERARCHY_2,

	HIERARCHY_4,

	HIERARCHY_AUTO

} fe_hierarchy_t;

};



typedef enum fe_hierarchy fe_hierarchy_t;



enum fe_interleaving {

	INTERLEAVING_NONE,