[media] DocBook: improve documentation for hierarchy

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

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml
index 5f30a28a15b0a0ff52572c423d0be3a087c61f74..ae9bc1e089cc6e6f3e37be94ac1b5056572ad785 100644 (file)
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -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>

diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index a005c4b472f5801269dd28e2049885105d522286..d81b3ff332954dcbe1ba76167cf94f6954a1eb78 100644 (file)
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -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>
 

diff --git a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
index d20f1fd75fa9d2d7e269c14f8fcede66c2ba2eb9..cb2e1838130569ff2d4f0d48d919c669e369430c 100644 (file)
--- a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
+++ b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
@@ -183,7 +183,7 @@ struct dvb_vsb_parameters {
         &fe-modulation-t;     constellation; /⋆ modulation type (see above) ⋆/
         &fe-transmit-mode-t;  transmission_mode;
         &fe-guard-interval-t; guard_interval;
-        fe_hierarchy_t      hierarchy_information;
+        &fe-hierarchy-t;      hierarchy_information;
  };
 </programlisting>
 </section>

diff --git a/include/uapi/linux/dvb/frontend.h b/include/uapi/linux/dvb/frontend.h
index 1d2b7c6dee04c61c087326e06cbe93a92bd4713a..3a7ff9002654e12d3f03ebfe2af77aa2f75a4bb2 100644 (file)
--- a/include/uapi/linux/dvb/frontend.h
+++ b/include/uapi/linux/dvb/frontend.h
@@ -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,