Re: [PATCH] DocBook validation fixes

2012-08-13 Thread Mauro Carvalho Chehab 
Em 12-08-2012 09:02, Hans Verkuil escreveu:
 More validation fixes as reported by xmllint.
 
 There are still three xmllint errors remaining after this patch regarding SVG 
 file support.

How are you running xmllint? It could be useful to have a make target
(if it doesn't have it yet), in order for developers (and for me, when
checking patches) to run it.

 
 Signed-off-by: Hans Verkuil hans.verk...@cisco.com
 ---
  Documentation/DocBook/media/Makefile   |2 +-
  Documentation/DocBook/media/dvb/dvbproperty.xml|   20 +-
  Documentation/DocBook/media/dvb/frontend.xml   |   20 ++
  Documentation/DocBook/media/v4l/controls.xml   |4 +++-
  Documentation/DocBook/media/v4l/dev-subdev.xml |   20 +-
  .../DocBook/media/v4l/pixfmt-srggb10dpcm8.xml  |3 +--
  Documentation/DocBook/media/v4l/selection-api.xml  |   22 
 ++--
  .../DocBook/media/v4l/vidioc-g-selection.xml   |9 
  Documentation/DocBook/media/v4l/vidioc-qbuf.xml|2 ++
  .../media/v4l/vidioc-subdev-g-selection.xml|8 +++
  10 files changed, 57 insertions(+), 53 deletions(-)
 
 diff --git a/Documentation/DocBook/media/Makefile 
 b/Documentation/DocBook/media/Makefile
 index 3625209..9b7e4c5 100644
 --- a/Documentation/DocBook/media/Makefile
 +++ b/Documentation/DocBook/media/Makefile
 @@ -300,7 +300,7 @@ $(MEDIA_OBJ_DIR)/media-entities.tmpl: 
 $(MEDIA_OBJ_DIR)/v4l2.xml
   @(  \
   for ident in $(IOCTLS) ; do \
 entity=`echo $$ident | tr _ -` ;  \
 -   id=`grep refname$$ident $(MEDIA_OBJ_DIR)/vidioc-*.xml | sed -r 
 s,^.*/(.*).xml.*,\1,` ; \
 +   id=`grep refname$$ident $(MEDIA_OBJ_DIR)/vidioc-*.xml 
 $(MEDIA_OBJ_DIR)/media-ioc-*.xml | sed -r s,^.*/(.*).xml.*,\1,` ; \
 echo !ENTITY $$entity \link  \
   linkend='$$id'constant$$ident/constant/link\ \
 $@ ;\
 diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml 
 b/Documentation/DocBook/media/dvb/dvbproperty.xml
 index bb4777a..8adab98 100644
 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml
 +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
 @@ -567,33 +567,33 @@ typedef enum fe_delivery_system {
   
 titleconstantDTV_ATSCMH_RS_FRAME_MODE/constant/title
   paraRS frame mode./para
   paraPossible values are:/para
 -   section id=atscmh-rs-frame-mode
 +   para id=atscmh-rs-frame-mode
  programlisting
  typedef enum atscmh_rs_frame_mode {
   ATSCMH_RSFRAME_PRI_ONLY  = 0,
   ATSCMH_RSFRAME_PRI_SEC   = 1,
  } atscmh_rs_frame_mode_t;
  /programlisting
 -   /section
 +   /para
   /section
   section id=DTV-ATSCMH-RS-FRAME-ENSEMBLE
   
 titleconstantDTV_ATSCMH_RS_FRAME_ENSEMBLE/constant/title
   paraRS frame ensemble./para
   paraPossible values are:/para
 -   section id=atscmh-rs-frame-ensemble
 +   para id=atscmh-rs-frame-ensemble
  programlisting
  typedef enum atscmh_rs_frame_ensemble {
   ATSCMH_RSFRAME_ENS_PRI   = 0,
   ATSCMH_RSFRAME_ENS_SEC   = 1,
  } atscmh_rs_frame_ensemble_t;
  /programlisting
 -   /section
 +   /para
   /section
   section id=DTV-ATSCMH-RS-CODE-MODE-PRI
   
 titleconstantDTV_ATSCMH_RS_CODE_MODE_PRI/constant/title
   paraRS code mode (primary)./para
   paraPossible values are:/para
 -   section id=atscmh-rs-code-mode
 +   para id=atscmh-rs-code-mode
  programlisting
  typedef enum atscmh_rs_code_mode {
   ATSCMH_RSCODE_211_187= 0,
 @@ -601,7 +601,7 @@ typedef enum atscmh_rs_code_mode {
   ATSCMH_RSCODE_235_187= 2,
  } atscmh_rs_code_mode_t;
  /programlisting
 -   /section
 +   /para
   /section
   section id=DTV-ATSCMH-RS-CODE-MODE-SEC
   
 titleconstantDTV_ATSCMH_RS_CODE_MODE_SEC/constant/title
 @@ -619,27 +619,27 @@ typedef enum atscmh_rs_code_mode {
   
 titleconstantDTV_ATSCMH_SCCC_BLOCK_MODE/constant/title
   paraSeries Concatenated Convolutional Code Block 
 Mode./para
   paraPossible values are:/para
 -   section id=atscmh-sccc-block-mode
 +   para id=atscmh-sccc-block-mode
  programlisting
  typedef enum atscmh_sccc_block_mode {
   ATSCMH_SCCC_BLK_SEP  = 0,
   ATSCMH_SCCC_BLK_COMB = 1,
  } atscmh_sccc_block_mode_t;
  /programlisting
 -   /section
 +   /para
   /section
   section

Re: [PATCH] DocBook validation fixes

2012-08-13 Thread Hans Verkuil 
On Mon August 13 2012 20:02:54 Mauro Carvalho Chehab wrote:
 Em 12-08-2012 09:02, Hans Verkuil escreveu:
  More validation fixes as reported by xmllint.
  
  There are still three xmllint errors remaining after this patch regarding 
  SVG file support.
 
 How are you running xmllint? It could be useful to have a make target
 (if it doesn't have it yet), in order for developers (and for me, when
 checking patches) to run it.

I use this script to build the documentation:

== gitdocs.sh ==
#!/bin/sh

make DOCBOOKS=media_api.xml htmldocs
xmllint --noent --postvalid 
/home/hans/work/src/v4l/media-git/Documentation/DocBook/media_api.xml 
/tmp/x.xml 2/dev/null
xmllint --noent --postvalid --noout /tmp/x.xml
xmlto html-nochunks -m Documentation/DocBook/stylesheet.xsl -o 
Documentation/DocBook/media Documentation/DocBook/media_api.xml 
--skip-validation

echo 
file:///home/hans/work/src/v4l/media-git/Documentation/DocBook/media/media_api.html
== gitdocs.sh ==

I use this to build the documentation in one large file (that's what the daily
build does as well). I prefer that to the 'chunky' version and the validation 
works
better as well.

If you run xmlto without the --skip-validation at the end, then xmlto will run
xmllint by itself. Unfortunately, the file and line numbers it report are all 
out
of sync and they make it next to impossible to track down where an error occurs.

So I finally figured out this weekend how to run xmllint separately in such a 
way
that I can related the line numbers to actual docbook code.

That's why you see the first xmllint call generating a /tmp/x.xml file, and the
second is parsing it.

The last 'echo' is just to print where the generated doc is so I can easily open
it with my browser :-)

Regards,

Hans
--
To unsubscribe from this list: send the line unsubscribe linux-media in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] DocBook validation fixes

2012-08-12 Thread Hans Verkuil 
More validation fixes as reported by xmllint.

There are still three xmllint errors remaining after this patch regarding SVG 
file support.

Signed-off-by: Hans Verkuil hans.verk...@cisco.com
---
 Documentation/DocBook/media/Makefile   |2 +-
 Documentation/DocBook/media/dvb/dvbproperty.xml|   20 +-
 Documentation/DocBook/media/dvb/frontend.xml   |   20 ++
 Documentation/DocBook/media/v4l/controls.xml   |4 +++-
 Documentation/DocBook/media/v4l/dev-subdev.xml |   20 +-
 .../DocBook/media/v4l/pixfmt-srggb10dpcm8.xml  |3 +--
 Documentation/DocBook/media/v4l/selection-api.xml  |   22 ++--
 .../DocBook/media/v4l/vidioc-g-selection.xml   |9 
 Documentation/DocBook/media/v4l/vidioc-qbuf.xml|2 ++
 .../media/v4l/vidioc-subdev-g-selection.xml|8 +++
 10 files changed, 57 insertions(+), 53 deletions(-)

diff --git a/Documentation/DocBook/media/Makefile 
b/Documentation/DocBook/media/Makefile
index 3625209..9b7e4c5 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -300,7 +300,7 @@ $(MEDIA_OBJ_DIR)/media-entities.tmpl: 
$(MEDIA_OBJ_DIR)/v4l2.xml
@(  \
for ident in $(IOCTLS) ; do \
  entity=`echo $$ident | tr _ -` ;  \
- id=`grep refname$$ident $(MEDIA_OBJ_DIR)/vidioc-*.xml | sed -r 
s,^.*/(.*).xml.*,\1,` ; \
+ id=`grep refname$$ident $(MEDIA_OBJ_DIR)/vidioc-*.xml 
$(MEDIA_OBJ_DIR)/media-ioc-*.xml | sed -r s,^.*/(.*).xml.*,\1,` ; \
  echo !ENTITY $$entity \link  \
linkend='$$id'constant$$ident/constant/link\ \
  $@ ;\
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml 
b/Documentation/DocBook/media/dvb/dvbproperty.xml
index bb4777a..8adab98 100644
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -567,33 +567,33 @@ typedef enum fe_delivery_system {

titleconstantDTV_ATSCMH_RS_FRAME_MODE/constant/title
paraRS frame mode./para
paraPossible values are:/para
- section id=atscmh-rs-frame-mode
+ para id=atscmh-rs-frame-mode
 programlisting
 typedef enum atscmh_rs_frame_mode {
ATSCMH_RSFRAME_PRI_ONLY  = 0,
ATSCMH_RSFRAME_PRI_SEC   = 1,
 } atscmh_rs_frame_mode_t;
 /programlisting
- /section
+ /para
/section
section id=DTV-ATSCMH-RS-FRAME-ENSEMBLE

titleconstantDTV_ATSCMH_RS_FRAME_ENSEMBLE/constant/title
paraRS frame ensemble./para
paraPossible values are:/para
- section id=atscmh-rs-frame-ensemble
+ para id=atscmh-rs-frame-ensemble
 programlisting
 typedef enum atscmh_rs_frame_ensemble {
ATSCMH_RSFRAME_ENS_PRI   = 0,
ATSCMH_RSFRAME_ENS_SEC   = 1,
 } atscmh_rs_frame_ensemble_t;
 /programlisting
- /section
+ /para
/section
section id=DTV-ATSCMH-RS-CODE-MODE-PRI

titleconstantDTV_ATSCMH_RS_CODE_MODE_PRI/constant/title
paraRS code mode (primary)./para
paraPossible values are:/para
- section id=atscmh-rs-code-mode
+ para id=atscmh-rs-code-mode
 programlisting
 typedef enum atscmh_rs_code_mode {
ATSCMH_RSCODE_211_187= 0,
@@ -601,7 +601,7 @@ typedef enum atscmh_rs_code_mode {
ATSCMH_RSCODE_235_187= 2,
 } atscmh_rs_code_mode_t;
 /programlisting
- /section
+ /para
/section
section id=DTV-ATSCMH-RS-CODE-MODE-SEC

titleconstantDTV_ATSCMH_RS_CODE_MODE_SEC/constant/title
@@ -619,27 +619,27 @@ typedef enum atscmh_rs_code_mode {

titleconstantDTV_ATSCMH_SCCC_BLOCK_MODE/constant/title
paraSeries Concatenated Convolutional Code Block 
Mode./para
paraPossible values are:/para
- section id=atscmh-sccc-block-mode
+ para id=atscmh-sccc-block-mode
 programlisting
 typedef enum atscmh_sccc_block_mode {
ATSCMH_SCCC_BLK_SEP  = 0,
ATSCMH_SCCC_BLK_COMB = 1,
 } atscmh_sccc_block_mode_t;
 /programlisting
- /section
+ /para
/section
section id=DTV-ATSCMH-SCCC-CODE-MODE-A

titleconstantDTV_ATSCMH_SCCC_CODE_MODE_A/constant/title
paraSeries Concatenated Convolutional Code 
Rate./para