Skip to contentSkip to conversation

DocBook/media: Add isdb-t documentation

hg:v4l-dvb Mauro Carvalho Chehab 2 participants 3 messages Sep 17, 2009 Media (V4L/DVB)

lore
Share & tools
lore
#0 lore raw

Hi Patrick,

I've added the isdb-t docs at the new media DocBook. Please double check. It were generated from your text document at dvb-spec dir.

For your convenience, it is already compiled at linuxtv.org/docs.php:

	http://linuxtv.org/downloads/v4l-dvb-apis/ch09s03.html

(and the site will automatically update if we change something at the docbook).

You can also compile it locally with "make spec". You need to have xmlto and the oasis DTD's, in order to compile.

It is understandable that most of us were afraid on touching at LaTex docs, but having everything in DocBook makes easier for people to update: just one language, XML based. For those seeking for a good XML editor, I recommend quanta. It comes together with kde (on RHEL, the package name is kdewebdev). Don't forget to say to the editor to use DocBook XML 4.1.2 format.

Starting from now, I kindly ask developers that need to touch at Media API to always send an update to the DocBook. It would be great if someone could write a complete S2API spec.

Cheers,
Mauro.

Forwarded message:

Date: Thu, 17 Sep 2009 04:25:02 +0200
From: Patch from Mauro Carvalho Chehab <[email protected]>
To: [email protected]
Cc: Mauro Carvalho Chehab <[email protected]>, Mauro Carvalho Chehab <[email protected]>
Subject: [hg:v4l-dvb] DocBook/media: Add isdb-t documentation

The patch number 12915 was added via Mauro Carvalho Chehab <[email protected]> to http://linuxtv.org/hg/v4l-dvb master development tree.

Kernel patches in this development tree may be modified to be backward compatible with older kernels. Compatibility modifications will be removed before inclusion into the mainstream Kernel

If anyone has any objections, please let us know by sending a message to:
Linux Media Mailing List <[email protected]>

------

From: Mauro Carvalho Chehab <[email protected]>
DocBook/media: Add isdb-t documentation

Adds ISDB-T_and_ISDB-Tsb_with_S2API spec converted into DocBook format.

The text is authored by Patrick Boettcher, and was converted to DocBook by me.

Priority: normal

---

 linux/Documentation/DocBook/dvb/dvbapi.xml   |    8 
 linux/Documentation/DocBook/dvb/frontend.xml |    1 
 linux/Documentation/DocBook/dvb/isdbt.xml    |  313 +++++++++++++++++++
 media-specs/Makefile                         |    1 
 4 files changed, 323 insertions(+)
linux/Documentation/DocBook/dvb/dvbapi.xml +8 -0
diff -r 258d168cf311 -r 72b7493653f7 linux/Documentation/DocBook/dvb/dvbapi.xml
@@ -30,6 +30,14 @@
 <revhistory>
 <!-- Put document revisions here, newest first. -->
 <revision>
+<revnumber>2.0.1</revnumber>
+<date>2009-09-16</date>
+<authorinitials>mcc</authorinitials>
+<revremark>
+Added ISDB-T test originally written by Patrick Boettcher
+</revremark>
+</revision>
+<revision>
 <revnumber>2.0.0</revnumber>
 <date>2009-09-06</date>
 <authorinitials>mcc</authorinitials>
linux/Documentation/DocBook/dvb/frontend.xml +1 -0
diff -r 258d168cf311 -r 72b7493653f7 linux/Documentation/DocBook/dvb/frontend.xml
@@ -1763,3 +1763,4 @@
  </row></tbody></tgroup></informaltable>
 </section>
 </section>
+&sub-isdbt;
linux/Documentation/DocBook/dvb/isdbt.xml new file +313 -0

314 lines not on this page · raw message

media-specs/Makefile +1 -0
diff -r 258d168cf311 -r 72b7493653f7 media-specs/Makefile
@@ -115,6 +115,7 @@
 DVB_SGMLS = \
 	dvb/intro.xml \
 	dvb/frontend.xml \
+	dvb/isdbt.xml \
 	dvb/demux.xml \
 	dvb/video.xml \
 	dvb/audio.xml \

---

Patch is available at: http://linuxtv.org/hg/v4l-dvb/rev/72b7493653f74bcd0017036afaef924e77eba450

Cheers,
Mauro

#1 lore raw

Hi Mauro,

Quoted 4 lines · Mauro Carvalho Chehab

Hi Patrick,

I've added the isdb-t docs at the new media DocBook. Please double check. It were generated from your text document at dvb-spec dir.

Thanks a lot for doing this job :) . You didn't remove the txt-file. Any future change I will do in the DocBook, so no need anymore for the txt-file.

Quoted 3 lines

Starting from now, I kindly ask developers that need to touch at Media API to always send an update to the DocBook. It would be great if someone could write a complete S2API spec.

Hmm... as ISDB-T is based on S2API-mechanisms, it should not be that hard...

Should we do a list of S2API-ids described per standard? Like that e.g. frequency would appear everytime, but as it has a different meaning/scale for different standards, it seems logic to split it up in standards.

--

Patrick
http://www.kernellabs.com/

#2 lore raw

Em Thu, 17 Sep 2009 09:06:44 +0200 (CEST) Patrick Boettcher <[email protected]> escreveu:

Quoted 4 lines

Hi Mauro,

On Thu, 17 Sep 2009, Mauro Carvalho Chehab wrote:

Quoted 8 lines
Quoted 4 lines

Hi Patrick,

I've added the isdb-t docs at the new media DocBook. Please double check. It were generated from your text document at dvb-spec dir.

Thanks a lot for doing this job :) . You didn't remove the txt-file. Any future change I will do in the DocBook, so no need anymore for the txt-file.

Ok. I'll do a patch removing the txt.

Quoted 10 lines
Quoted 3 lines

Starting from now, I kindly ask developers that need to touch at Media API to always send an update to the DocBook. It would be great if someone could write a complete S2API spec.

Hmm... as ISDB-T is based on S2API-mechanisms, it should not be that hard...

Should we do a list of S2API-ids described per standard? Like that e.g. frequency would appear everytime, but as it has a different meaning/scale for different standards, it seems logic to split it up in standards.

Good point.

Maybe we can have an initial section with the common parameters, adding <xref> to each standard for details.

Another possibility would be to have a table with all S2API-id's x all
standards, saying yes/no if that tag applies. If yes, <xref> or <callout> pointing to each standard meaning. Like:

|PARAMETER    | DVB-S2 |ISDB-T |	...
+-------------+--------+--------+ ...

FREQ YES(1) YES(2) ...
LAYER_A NO YES(3) ...
...

Cheers,
Mauro