[PATCH 00/15] DVB Frontend Documentation patches

[PATCH 00/15] DVB Frontend Documentation patches

[Mauro Carvalho Chehab]

This series of patches updates the DVB v5 documentation, sinchronizing
the current implementation with the API spec.
Among other things, it:
	- adds a logic that discovers API gaps between the header
	  file and the API specs;
	- adds/fixes the DVB S2API (DVBv5) additions;
	- adds the FE_ATSC frontend descriptions (both v3 and v5);
	- adds a relation of DVBv5 parameters for usage for each
	  supported delivery system.

The API updates were made at the best effort basis, by doing a sort
of "reverse engineering" approach, e. g., by looking at the code
and trying to figure out what changed, why and how. Due to that,
I bet people will find errors on it. Also, English is not my native
language, and I didn't have time for doing a language review.

so I'm sure that language/style/typo fixes are needed.

So, I'd like to encourage people to carefully read the docs and
send us patches with fixes.

Anyway, as the situation after those patches are better than before them,
I'm pushing it to the main repository. This helps to review, as the
linuxtv scripts will re-format the DocBook into html.

Mauro Carvalho Chehab (15):
  [media] DocBook/Makefile: add references for several dvb structures
  [media] DocBook/frontend.xml: Better document fe_type_t
  [media] DocBook/frontend.xml: Link DVB S2API parameters
  [media] DocBook/frontend.xml: Correlate dvb delivery systems
  [media] DocBook/frontend.xml: add references for some missing info
  [media] DocBook/frontend.xml: Better describe the frontend parameters
  [media] DocBook/dvbproperty.xml: Document the remaining S2API parameters
  [media] DocBook/dvbproperty.xml: Use links for all parameters
  [media] DocBook/dvbproperty.xml: Reorganize the parameters
  [media] DocBook/frontend.xml: Recomend the usage of the new API
  [media] DocBook/dvbproperty.xml: Document the terrestrial delivery systems
  [media] DocBook: Finish synchronizing the frontend API
  [media] DocBook/dvbproperty.xml: Add Cable standards
  [media] DocBook/dvbproperty.xml: Add ATSC standard
  [media] DocBook/dvbproperty.xml: Add Satellite standards

 Documentation/DocBook/media/Makefile            |   17 +-
 Documentation/DocBook/media/dvb/dvbproperty.xml |  965 +++++++++++++++--------
 Documentation/DocBook/media/dvb/frontend.xml    |  285 +++++---
 3 files changed, 833 insertions(+), 434 deletions(-)

[PATCH 16/15] [media] DocBook/dvbproperty.xml: Better name the ISDB-T layers

[Mauro Carvalho Chehab]

In order to improve the DVB index, replace the title to a
better name.

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

diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml
index a9863a3..caec58c 100644
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -449,13 +449,14 @@ typedef enum fe_delivery_system {
 		<para>Note: This value cannot be determined by an automatic channel search.</para>
 	</section>
 	<section id="isdb-hierq-layers">
-		<title>Hierarchical layers</title>
+		<title><constant>DTV-ISDBT-LAYER*</constant> parameters</title>
 		<para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
 			ISDB-T hierarchical layers can be decoded simultaneously. For that
 			reason a ISDB-T demodulator has 3 viterbi and 3 reed-solomon-decoders.</para>
 		<para>ISDB-T has 3 hierarchical layers which each can use a part of the
 			available segments. The total number of segments over all layers has
 			to 13 in ISDB-T.</para>
+		<para>There are 3 parameter sets, for Layers A, B and C.</para>
 		<section id="DTV-ISDBT-LAYER-ENABLED">
 			<title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title>
 			<para>Hierarchical reception in ISDB-T is achieved by enabling or disabling

Re: [PATCH 00/15] DVB Frontend Documentation patches

[Mauro Carvalho Chehab]

Em 07-06-2011 22:45, Mauro Carvalho Chehab escreveu:
> This series of patches updates the DVB v5 documentation, sinchronizing
> the current implementation with the API spec.
> Among other things, it:
> 	- adds a logic that discovers API gaps between the header
> 	  file and the API specs;
> 	- adds/fixes the DVB S2API (DVBv5) additions;
> 	- adds the FE_ATSC frontend descriptions (both v3 and v5);
> 	- adds a relation of DVBv5 parameters for usage for each
> 	  supported delivery system.
> 
> The API updates were made at the best effort basis, by doing a sort
> of "reverse engineering" approach, e. g., by looking at the code
> and trying to figure out what changed, why and how. Due to that,
> I bet people will find errors on it. Also, English is not my native
> language, and I didn't have time for doing a language review.
> 
> so I'm sure that language/style/typo fixes are needed.
> 
> So, I'd like to encourage people to carefully read the docs and
> send us patches with fixes.
> 
> Anyway, as the situation after those patches are better than before them,
> I'm pushing it to the main repository. This helps to review, as the
> linuxtv scripts will re-format the DocBook into html.

The linuxtv API specs were updated at linuxtv.org. For those that want 
to review, the changes were at chapter 9 of the API spec[1], mainly at:

http://linuxtv.org/downloads/v4l-dvb-apis/dvb_frontend.html
http://linuxtv.org/downloads/v4l-dvb-apis/FE_GET_SET_PROPERTY.html
http://linuxtv.org/downloads/v4l-dvb-apis/frontend_h.html

[1] http://linuxtv.org/downloads/v4l-dvb-apis/

Cheers,
Mauro.