RE: Help in adding documentation

RE: Help in adding documentation

[Karicheri, Muralidharan]

After compilation I get the following error

Error: no ID for contstraint linkend: v4l2-dv-enum-presets.

v4l2-dv-enum-presets is the new structure type added. 


Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Karicheri, Muralidharan
>Sent: Tuesday, November 17, 2009 10:58 AM
>To: 'Mauro Carvalho Chehab'
>Cc: 'Hans Verkuil'; linux-media@vger.kernel.org
>Subject: Help in adding documentation
>
>Hi Mauro,
>
>Is there some instructions on adding new sections in the v4l2 documentation.
>I had been struggling yesterday to add my documentation for video timing
>API. It is easy to make minor documentation changes. But since I am adding
>new ioctls, Looks like I need to create vidioc-<xxx>.xml under DoCBook/v4l/
>directory since media-specs/Makefile is generating videodev2.h.xml
>automatically (I learned it in the hard way). I have added the IOCTL name
>in media-specs/Makefile and also added the structure name. But somehow, the
>videodev2.h.xml file doesn't show my structure types documented in vidioc-
><xxx>.xml. Any idea what could be wrong?
>
>Murali Karicheri
>Software Design Engineer
>Texas Instruments Inc.
>Germantown, MD 20874
>phone: 301-407-9583
>email: m-karicheri2@ti.com

Re: Help in adding documentation

[Mauro Carvalho Chehab]

Em Tue, 17 Nov 2009 10:00:07 -0600
"Karicheri, Muralidharan" <m-karicheri2@ti.com> escreveu:

> >Hi Mauro,
> >
> >Is there some instructions on adding new sections in the v4l2 documentation.

No, sorry. The documentation build is undocumented..

> >I had been struggling yesterday to add my documentation for video timing
> >API. It is easy to make minor documentation changes. But since I am adding
> >new ioctls, Looks like I need to create vidioc-<xxx>.xml under DoCBook/v4l/
> >directory since media-specs/Makefile is generating videodev2.h.xml
> >automatically (I learned it in the hard way). 

Yes, this is the better way: create a separate xml file for it, to keep the
same concept used there.

> >I have added the IOCTL name
> >in media-specs/Makefile and also added the structure name. 

We may try to add the ioctls automatically at the Makefile. I started doing things
like that at the DVB side of the Makefile. It is not that hard, since all we need
to do is to check for _IO defines at videodev2.h.

> >But somehow, the
> >videodev2.h.xml file doesn't show my structure types documented in vidioc-
> ><xxx>.xml. Any idea what could be wrong?

Probably, the name is wrong. Maybe lower-case/upper-case? Some DocBook tool
versions are case sensitive, while others aren't.

> After compilation I get the following error
> Error: no ID for contstraint linkend: v4l2-dv-enum-presets.
> v4l2-dv-enum-presets is the new structure type added. 

This probably means that videodev2.h has it defined, while you didn't have the
link id created at the xml file you've created.

You probably need a tag like:

<table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
<!-- your enum table -->
</table>


Cheers,
Mauro

RE: Help in adding documentation

[Karicheri, Muralidharan]

Mauro,

Thanks for your reply. I made progress after my email. My new file
is being processed by Makefile now. I have some issues with some
tags.

>
>This probably means that videodev2.h has it defined, while you didn't have

Do you mean videodev2.h.xml? I see there videodev2.h under linux/include. Do I need to copy my latest videodev2.h to that directory?

>the
>link id created at the xml file you've created.
>
>You probably need a tag like:
>
><table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
><!-- your enum table -->
></table>
>
>
>Cheers,
>Mauro
>--
>To unsubscribe from this list: send the line "unsubscribe linux-media" in
>the body of a message to majordomo@vger.kernel.org
>More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: Help in adding documentation

[Mauro Carvalho Chehab]

Karicheri, Muralidharan escreveu:
> Mauro,
> 
> Thanks for your reply. I made progress after my email. My new file
> is being processed by Makefile now. I have some issues with some
> tags.
> 
>> This probably means that videodev2.h has it defined, while you didn't have
> 
> Do you mean videodev2.h.xml? I see there videodev2.h under linux/include. Do I need to copy my latest videodev2.h to that directory?

videodev2.h.xml is generated automatically by Makefile, from videodev2.h.

Basically, Makefile scripts will parse it, search for certain structs/enums/ioctls and
generate videodev2.h.xml.

What happens is that you likely declared the presets enum on videodev2.h, and the
enum got detected, producing a <linkend> tag. However, as you didn't define the
reference ID for that tag on your xml file, you got an error.
> 
>> the
>> link id created at the xml file you've created.
>>
>> You probably need a tag like:
>>
>> <table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
>> <!-- your enum table -->
>> </table>
>>
>>
>> Cheers,
>> Mauro
>> --
>> To unsubscribe from this list: send the line "unsubscribe linux-media" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 

RE: Help in adding documentation

[Karicheri, Muralidharan]

Mauro,

Thanks to your help, I could finish my documentation today.

But I have another issue with the v4l2-apps.

When I do make apps, it doesn't seem to build. I get the following error
logs... Is this broken?

Thanks.
Murali

make -C /local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l apps
make[1]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l'
make -C ../v4l2-apps
make[2]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps'
if [ ! -d include ]; then \
	cp -r ../linux/include include ; \
	../v4l/scripts/headers_convert.pl `find include -type f` ; \
fi
make -C libv4l all
make[3]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l'
make -C libv4lconvert V4L2_LIB_VERSION=0.6.2-test all
make[4]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l/libv4lconvert'
cc -Wp,-MMD,"libv4lconvert.d",-MQ,"libv4lconvert.o",-MP -c -I../include -I../../../include -fvisibility=hidden -fPIC -DLIBDIR=\"/usr/local/lib\" -DLIBSUBDIR=\"libv4l\" -g -O1 -Wall -Wno-unused -Wpointer-arith -Wstrict-prototypes -Wmissing-prototypes -o libv4lconvert.o libv4lconvert.c
In file included from libv4lconvert.c:25:
../include/libv4lconvert.h:100: warning: "struct v4l2_frmsizeenum" declared inside parameter list
../include/libv4lconvert.h:100: warning: its scope is only this definition or declaration, which is probably not what you want
../include/libv4lconvert.h:105: warning: "struct v4l2_frmivalenum" declared inside parameter list
In file included from libv4lconvert.c:26:
libv4lconvert-priv.h:129: error: field `framesizes' has incomplete type
libv4lconvert.c: In function `v4lconvert_get_framesizes':
libv4lconvert.c:1121: error: variable `frmsize' has initializer but incomplete type
libv4lconvert.c:1121: error: unknown field `pixel_format' specified in initializer
libv4lconvert.c:1121: warning: excess elements in struct initializer
libv4lconvert.c:1121: warning: (near initialization for `frmsize')
libv4lconvert.c:1121: error: storage size of 'frmsize' isn't known
libv4lconvert.c:1125: error: `VIDIOC_ENUM_FRAMESIZES' undeclared (first use in this function)
libv4lconvert.c:1125: error: (Each undeclared identifier is reported only once
libv4lconvert.c:1125: error: for each function it appears in.)
libv4lconvert.c:1135: error: `V4L2_FRMSIZE_TYPE_DISCRETE' undeclared (first use in this function)
libv4lconvert.c:1140: error: `V4L2_FRMSIZE_TYPE_CONTINUOUS' undeclared (first use in this function)
libv4lconvert.c:1141: error: `V4L2_FRMSIZE_TYPE_STEPWISE' undeclared (first use in this function)
libv4lconvert.c: In function `v4lconvert_enum_framesizes':
libv4lconvert.c:1180: error: dereferencing pointer to incomplete type
libv4lconvert.c:1185: error: `VIDIOC_ENUM_FRAMESIZES' undeclared (first use in this function)
libv4lconvert.c:1188: error: dereferencing pointer to incomplete type
libv4lconvert.c:1193: error: dereferencing pointer to incomplete type
libv4lconvert.c:1193: error: dereferencing pointer to incomplete type
libv4lconvert.c:1194: error: dereferencing pointer to incomplete type
libv4lconvert.c:1195: error: `V4L2_FRMSIZE_TYPE_DISCRETE' undeclared (first use in this function)
libv4lconvert.c:1196: error: dereferencing pointer to incomplete type
libv4lconvert.c:1196: error: dereferencing pointer to incomplete type
libv4lconvert.c:1198: error: dereferencing pointer to incomplete type
libv4lconvert.c:1199: error: dereferencing pointer to incomplete type
libv4lconvert.c:1201: error: `V4L2_FRMSIZE_TYPE_CONTINUOUS' undeclared (first use in this function)
libv4lconvert.c:1202: error: `V4L2_FRMSIZE_TYPE_STEPWISE' undeclared (first use in this function)
libv4lconvert.c:1203: error: dereferencing pointer to incomplete type
libv4lconvert.c:1203: error: dereferencing pointer to incomplete type
libv4lconvert.c: At top level:
libv4lconvert.c:1211: warning: "struct v4l2_frmivalenum" declared inside parameter list
libv4lconvert.c:1212: error: conflicting types for 'v4lconvert_enum_frameintervals'
../include/libv4lconvert.h:105: error: previous declaration of 'v4lconvert_enum_frameintervals' was here
libv4lconvert.c:1212: error: conflicting types for 'v4lconvert_enum_frameintervals'
../include/libv4lconvert.h:105: error: previous declaration of 'v4lconvert_enum_frameintervals' was here
libv4lconvert.c: In function `v4lconvert_enum_frameintervals':
libv4lconvert.c:1216: error: dereferencing pointer to incomplete type
libv4lconvert.c:1221: error: `VIDIOC_ENUM_FRAMEINTERVALS' undeclared (first use in this function)
libv4lconvert.c:1230: error: dereferencing pointer to incomplete type
libv4lconvert.c:1231: error: dereferencing pointer to incomplete type
libv4lconvert.c:1232: error: dereferencing pointer to incomplete type
libv4lconvert.c:1240: error: dereferencing pointer to incomplete type
libv4lconvert.c:1241: error: dereferencing pointer to incomplete type
libv4lconvert.c:1242: error: dereferencing pointer to incomplete type
libv4lconvert.c:1243: error: dereferencing pointer to incomplete type
libv4lconvert.c:1245: error: dereferencing pointer to incomplete type
libv4lconvert.c:1245: error: dereferencing pointer to incomplete type
libv4lconvert.c:1262: error: dereferencing pointer to incomplete type
libv4lconvert.c:1263: error: dereferencing pointer to incomplete type
libv4lconvert.c:1264: error: dereferencing pointer to incomplete type
libv4lconvert.c:1269: error: dereferencing pointer to incomplete type
libv4lconvert.c:1285: error: dereferencing pointer to incomplete type
libv4lconvert.c:1286: error: dereferencing pointer to incomplete type
libv4lconvert.c:1287: error: dereferencing pointer to incomplete type
make[4]: *** [libv4lconvert.o] Error 1
make[4]: Leaving directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l/libv4lconvert'
make[3]: *** [all] Error 2
make[3]: Leaving directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l'
make[2]: *** [all] Error 2
make[2]: Leaving directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps'
make[1]: *** [apps] Error 2
make[1]: Leaving directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l'
make: *** [apps] Error 2


Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Mauro Carvalho Chehab [mailto:mchehab@infradead.org]
>Sent: Tuesday, November 17, 2009 12:58 PM
>To: Karicheri, Muralidharan
>Cc: Hans Verkuil; linux-media@vger.kernel.org
>Subject: Re: Help in adding documentation
>
>Karicheri, Muralidharan escreveu:
>> Mauro,
>>
>> Thanks for your reply. I made progress after my email. My new file
>> is being processed by Makefile now. I have some issues with some
>> tags.
>>
>>> This probably means that videodev2.h has it defined, while you didn't
>have
>>
>> Do you mean videodev2.h.xml? I see there videodev2.h under linux/include.
>Do I need to copy my latest videodev2.h to that directory?
>
>videodev2.h.xml is generated automatically by Makefile, from videodev2.h.
>
>Basically, Makefile scripts will parse it, search for certain
>structs/enums/ioctls and
>generate videodev2.h.xml.
>
>What happens is that you likely declared the presets enum on videodev2.h,
>and the
>enum got detected, producing a <linkend> tag. However, as you didn't define
>the
>reference ID for that tag on your xml file, you got an error.
>>
>>> the
>>> link id created at the xml file you've created.
>>>
>>> You probably need a tag like:
>>>
>>> <table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
>>> <!-- your enum table -->
>>> </table>
>>>
>>>
>>> Cheers,
>>> Mauro
>>> --
>>> To unsubscribe from this list: send the line "unsubscribe linux-media"
>in
>>> the body of a message to majordomo@vger.kernel.org
>>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>>
>

Re: Help in adding documentation

[Mauro Carvalho Chehab]

Karicheri, Muralidharan escreveu:
> Mauro,
> 
> Thanks to your help, I could finish my documentation today.
> 
> But I have another issue with the v4l2-apps.
> 
> When I do make apps, it doesn't seem to build. I get the following error
> logs... Is this broken?

Well... no, it is not really broken, but the build system for v4l2-apps
needs serious improvements. There are some know issues on it:
	- It doesn't check/warn if you don't have all the dependencies
	  (qv4l2 and v4l2-sysfs-path require some development libraries
	   that aren't available per default when gcc is installed - I
	   think the other files there are ok);
	- make only works fine when calling on certain directories (it used to work
	  fine if you call it from /v4l2-apps/*) - but, since some patch, it now requires
	  that you call make from /v4l2-apps, in order to create v4l2-apps/include.
	  After having it created, make can be called from a /v4l2-apps subdir;
	- for some places (libv4l - maybe there are other places?), you need to
	  have the latest headers installed, as it doesn't use the one at the tree.
	- qv4l2 only compiles with qt3.

Patches are welcome to fix those issues and improve the v4l2-apps building system.

> make[3]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l'
> make -C libv4lconvert V4L2_LIB_VERSION=0.6.2-test all
> make[4]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l/libv4lconvert'
> cc -Wp,-MMD,"libv4lconvert.d",-MQ,"libv4lconvert.o",-MP -c -I../include -I../../../include -fvisibility=hidden -fPIC -DLIBDIR=\"/usr/local/lib\" -DLIBSUBDIR=\"libv4l\" -g -O1 -Wall -Wno-unused -Wpointer-arith -Wstrict-prototypes -Wmissing-prototypes -o libv4lconvert.o libv4lconvert.c
> In file included from libv4lconvert.c:25:
> ../include/libv4lconvert.h:100: warning: "struct v4l2_frmsizeenum" declared inside parameter list
> ../include/libv4lconvert.h:100: warning: its scope is only this definition or declaration, which is probably not what you want
> ../include/libv4lconvert.h:105: warning: "struct v4l2_frmivalenum" declared inside parameter list

In this specific case, it is trying to compile against /usr/include/linux/videodev2.h, instead of using
the in-tree header file.

Cheers,
Mauro.

Re: Help in adding documentation

[Hans Verkuil]

On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
> Karicheri, Muralidharan escreveu:
> > Mauro,
> > 
> > Thanks to your help, I could finish my documentation today.
> > 
> > But I have another issue with the v4l2-apps.
> > 
> > When I do make apps, it doesn't seem to build. I get the following error
> > logs... Is this broken?
> 
> Well... no, it is not really broken, but the build system for v4l2-apps
> needs serious improvements. There are some know issues on it:
> 	- It doesn't check/warn if you don't have all the dependencies
> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
> 	   that aren't available per default when gcc is installed - I
> 	   think the other files there are ok);
> 	- make only works fine when calling on certain directories (it used to work
> 	  fine if you call it from /v4l2-apps/*) - but, since some patch, it now requires
> 	  that you call make from /v4l2-apps, in order to create v4l2-apps/include.
> 	  After having it created, make can be called from a /v4l2-apps subdir;
> 	- for some places (libv4l - maybe there are other places?), you need to
> 	  have the latest headers installed, as it doesn't use the one at the tree.
> 	- qv4l2 only compiles with qt3.

I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time to work
on a series of patches to merge it in the main repo. And it is missing string
control support.

If anyone is interested, then feel free to do that work. This new qt4 version
is much better than the qt3 version.

Regards,

	Hans

> 
> Patches are welcome to fix those issues and improve the v4l2-apps building system.
> 
> > make[3]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l'
> > make -C libv4lconvert V4L2_LIB_VERSION=0.6.2-test all
> > make[4]: Entering directory `/local/mkaricheri/davinci_git/video_timing/new_v4l2-dvb/v4l-dvb-aba823ecaea6/v4l2-apps/libv4l/libv4lconvert'
> > cc -Wp,-MMD,"libv4lconvert.d",-MQ,"libv4lconvert.o",-MP -c -I../include -I../../../include -fvisibility=hidden -fPIC -DLIBDIR=\"/usr/local/lib\" -DLIBSUBDIR=\"libv4l\" -g -O1 -Wall -Wno-unused -Wpointer-arith -Wstrict-prototypes -Wmissing-prototypes -o libv4lconvert.o libv4lconvert.c
> > In file included from libv4lconvert.c:25:
> > ../include/libv4lconvert.h:100: warning: "struct v4l2_frmsizeenum" declared inside parameter list
> > ../include/libv4lconvert.h:100: warning: its scope is only this definition or declaration, which is probably not what you want
> > ../include/libv4lconvert.h:105: warning: "struct v4l2_frmivalenum" declared inside parameter list
> 
> In this specific case, it is trying to compile against /usr/include/linux/videodev2.h, instead of using
> the in-tree header file.
> 
> Cheers,
> Mauro.
> 



-- 
Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom

Re: Help in adding documentation

[Mauro Carvalho Chehab]

Hans Verkuil wrote:
> On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
>> Karicheri, Muralidharan escreveu:
>>> Mauro,
>>>
>>> Thanks to your help, I could finish my documentation today.
>>>
>>> But I have another issue with the v4l2-apps.
>>>
>>> When I do make apps, it doesn't seem to build. I get the following error
>>> logs... Is this broken?
>> Well... no, it is not really broken, but the build system for v4l2-apps
>> needs serious improvements. There are some know issues on it:
>> 	- It doesn't check/warn if you don't have all the dependencies
>> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
>> 	   that aren't available per default when gcc is installed - I
>> 	   think the other files there are ok);
>> 	- make only works fine when calling on certain directories (it used to work
>> 	  fine if you call it from /v4l2-apps/*) - but, since some patch, it now requires
>> 	  that you call make from /v4l2-apps, in order to create v4l2-apps/include.
>> 	  After having it created, make can be called from a /v4l2-apps subdir;
>> 	- for some places (libv4l - maybe there are other places?), you need to
>> 	  have the latest headers installed, as it doesn't use the one at the tree.
>> 	- qv4l2 only compiles with qt3.
> 
> I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time to work
> on a series of patches to merge it in the main repo. And it is missing string
> control support.
> 
> If anyone is interested, then feel free to do that work. This new qt4 version
> is much better than the qt3 version.

IMO, the better is to have both versions on separate dirs, and let the building
system to check if qt4 is available. If so, build the qt4 version instead of
qt3 (a configure script, for example). Otherwise, warn users that it is compiling
a legacy application, due to the lack of the proper dependencies.

Cheers,
Mauro.

Re: Help in adding documentation

[Hans Verkuil]

On Wednesday 18 November 2009 08:24:13 Mauro Carvalho Chehab wrote:
> Hans Verkuil wrote:
> > On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
> >> Karicheri, Muralidharan escreveu:
> >>> Mauro,
> >>>
> >>> Thanks to your help, I could finish my documentation today.
> >>>
> >>> But I have another issue with the v4l2-apps.
> >>>
> >>> When I do make apps, it doesn't seem to build. I get the following error
> >>> logs... Is this broken?
> >> Well... no, it is not really broken, but the build system for v4l2-apps
> >> needs serious improvements. There are some know issues on it:
> >> 	- It doesn't check/warn if you don't have all the dependencies
> >> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
> >> 	   that aren't available per default when gcc is installed - I
> >> 	   think the other files there are ok);
> >> 	- make only works fine when calling on certain directories (it used to work
> >> 	  fine if you call it from /v4l2-apps/*) - but, since some patch, it now requires
> >> 	  that you call make from /v4l2-apps, in order to create v4l2-apps/include.
> >> 	  After having it created, make can be called from a /v4l2-apps subdir;
> >> 	- for some places (libv4l - maybe there are other places?), you need to
> >> 	  have the latest headers installed, as it doesn't use the one at the tree.
> >> 	- qv4l2 only compiles with qt3.
> > 
> > I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time to work
> > on a series of patches to merge it in the main repo. And it is missing string
> > control support.
> > 
> > If anyone is interested, then feel free to do that work. This new qt4 version
> > is much better than the qt3 version.
> 
> IMO, the better is to have both versions on separate dirs, and let the building
> system to check if qt4 is available. If so, build the qt4 version instead of
> qt3 (a configure script, for example). Otherwise, warn users that it is compiling
> a legacy application, due to the lack of the proper dependencies.

I'm not going to maintain the qt3 version. Personally I think it is pointless
having two tools for this and it only creates confusion and unnecessary
maintenance cost. Of course, all this is moot as long as the new version is
still unmerged.

BTW: everything inside v4l2-apps should use the generated headers inside
v4l2-apps/include. These are generated from the headers in the tree and yes,
it would be nice if v4l2-apps/Makefile would have a proper dependency to
generate them. Now only the top-level Makefile knows about it. After that
include directory is generated you can do a make in v4l2-apps.

But libv4l should use those headers and not the installed headers. Something
may have been broken since when I last wrote that code.

Regards,

	Hans

-- 
Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom

RE: Help in adding documentation

[Karicheri, Muralidharan]

Hans & Mauro,

I tried building from v4l2-apps directory, but it doesn't help me
either. 

(qv4l2 and v4l2-sysfs-path require some development libraries
that aren't available per default when gcc is installed - I

What are all the libraries it requires? I need to do cross compile
for arm. What do I need to do to let the build system pull required
libraries from the code sorcery arm tool chain that I use? Any help
to build the application v4l2-ctl.cpp will be helpful.

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Hans Verkuil [mailto:hverkuil@xs4all.nl]
>Sent: Wednesday, November 18, 2009 2:33 AM
>To: Mauro Carvalho Chehab
>Cc: Karicheri, Muralidharan; linux-media@vger.kernel.org
>Subject: Re: Help in adding documentation
>
>On Wednesday 18 November 2009 08:24:13 Mauro Carvalho Chehab wrote:
>> Hans Verkuil wrote:
>> > On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
>> >> Karicheri, Muralidharan escreveu:
>> >>> Mauro,
>> >>>
>> >>> Thanks to your help, I could finish my documentation today.
>> >>>
>> >>> But I have another issue with the v4l2-apps.
>> >>>
>> >>> When I do make apps, it doesn't seem to build. I get the following
>error
>> >>> logs... Is this broken?
>> >> Well... no, it is not really broken, but the build system for v4l2-
>apps
>> >> needs serious improvements. There are some know issues on it:
>> >> 	- It doesn't check/warn if you don't have all the dependencies
>> >> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
>> >> 	   that aren't available per default when gcc is installed - I
>> >> 	   think the other files there are ok);
>> >> 	- make only works fine when calling on certain directories (it used
>to work
>> >> 	  fine if you call it from /v4l2-apps/*) - but, since some patch, it
>now requires
>> >> 	  that you call make from /v4l2-apps, in order to create v4l2-
>apps/include.
>> >> 	  After having it created, make can be called from a /v4l2-apps
>subdir;
>> >> 	- for some places (libv4l - maybe there are other places?), you need
>to
>> >> 	  have the latest headers installed, as it doesn't use the one at the
>tree.
>> >> 	- qv4l2 only compiles with qt3.
>> >
>> > I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time
>to work
>> > on a series of patches to merge it in the main repo. And it is missing
>string
>> > control support.
>> >
>> > If anyone is interested, then feel free to do that work. This new qt4
>version
>> > is much better than the qt3 version.
>>
>> IMO, the better is to have both versions on separate dirs, and let the
>building
>> system to check if qt4 is available. If so, build the qt4 version instead
>of
>> qt3 (a configure script, for example). Otherwise, warn users that it is
>compiling
>> a legacy application, due to the lack of the proper dependencies.
>
>I'm not going to maintain the qt3 version. Personally I think it is
>pointless
>having two tools for this and it only creates confusion and unnecessary
>maintenance cost. Of course, all this is moot as long as the new version is
>still unmerged.
>
>BTW: everything inside v4l2-apps should use the generated headers inside
>v4l2-apps/include. These are generated from the headers in the tree and yes,
>it would be nice if v4l2-apps/Makefile would have a proper dependency to
>generate them. Now only the top-level Makefile knows about it. After that
>include directory is generated you can do a make in v4l2-apps.
>
>But libv4l should use those headers and not the installed headers.
>Something
>may have been broken since when I last wrote that code.
>
>Regards,
>
>	Hans
>
>--
>Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom

RE: Help in adding documentation

[Karicheri, Muralidharan]

BTW,

I don't know what is qt4/qt3 that you are referring to.
I see qv4l2 in the directory v4l2-apps/qv4l2. 

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Hans Verkuil [mailto:hverkuil@xs4all.nl]
>Sent: Wednesday, November 18, 2009 2:33 AM
>To: Mauro Carvalho Chehab
>Cc: Karicheri, Muralidharan; linux-media@vger.kernel.org
>Subject: Re: Help in adding documentation
>
>On Wednesday 18 November 2009 08:24:13 Mauro Carvalho Chehab wrote:
>> Hans Verkuil wrote:
>> > On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
>> >> Karicheri, Muralidharan escreveu:
>> >>> Mauro,
>> >>>
>> >>> Thanks to your help, I could finish my documentation today.
>> >>>
>> >>> But I have another issue with the v4l2-apps.
>> >>>
>> >>> When I do make apps, it doesn't seem to build. I get the following
>error
>> >>> logs... Is this broken?
>> >> Well... no, it is not really broken, but the build system for v4l2-
>apps
>> >> needs serious improvements. There are some know issues on it:
>> >> 	- It doesn't check/warn if you don't have all the dependencies
>> >> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
>> >> 	   that aren't available per default when gcc is installed - I
>> >> 	   think the other files there are ok);
>> >> 	- make only works fine when calling on certain directories (it used
>to work
>> >> 	  fine if you call it from /v4l2-apps/*) - but, since some patch, it
>now requires
>> >> 	  that you call make from /v4l2-apps, in order to create v4l2-
>apps/include.
>> >> 	  After having it created, make can be called from a /v4l2-apps
>subdir;
>> >> 	- for some places (libv4l - maybe there are other places?), you need
>to
>> >> 	  have the latest headers installed, as it doesn't use the one at the
>tree.
>> >> 	- qv4l2 only compiles with qt3.
>> >
>> > I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time
>to work
>> > on a series of patches to merge it in the main repo. And it is missing
>string
>> > control support.
>> >
>> > If anyone is interested, then feel free to do that work. This new qt4
>version
>> > is much better than the qt3 version.
>>
>> IMO, the better is to have both versions on separate dirs, and let the
>building
>> system to check if qt4 is available. If so, build the qt4 version instead
>of
>> qt3 (a configure script, for example). Otherwise, warn users that it is
>compiling
>> a legacy application, due to the lack of the proper dependencies.
>
>I'm not going to maintain the qt3 version. Personally I think it is
>pointless
>having two tools for this and it only creates confusion and unnecessary
>maintenance cost. Of course, all this is moot as long as the new version is
>still unmerged.
>
>BTW: everything inside v4l2-apps should use the generated headers inside
>v4l2-apps/include. These are generated from the headers in the tree and yes,
>it would be nice if v4l2-apps/Makefile would have a proper dependency to
>generate them. Now only the top-level Makefile knows about it. After that
>include directory is generated you can do a make in v4l2-apps.
>
>But libv4l should use those headers and not the installed headers.
>Something
>may have been broken since when I last wrote that code.
>
>Regards,
>
>	Hans
>
>--
>Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom

RE: Help in adding documentation

[Karicheri, Muralidharan]

Hans,

It is hard for me to get the v4l2-apps compile on my build environment.
Unless someone can help me to resolve the build issue, I wouldn't be able to update the v4l2-apps or Alternately someone volunteer to add this support
based on the API.

Thanks and regards,

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: linux-media-owner@vger.kernel.org [mailto:linux-media-
>owner@vger.kernel.org] On Behalf Of Karicheri, Muralidharan
>Sent: Thursday, November 19, 2009 11:26 AM
>To: Hans Verkuil; Mauro Carvalho Chehab
>Cc: linux-media@vger.kernel.org
>Subject: RE: Help in adding documentation
>
>BTW,
>
>I don't know what is qt4/qt3 that you are referring to.
>I see qv4l2 in the directory v4l2-apps/qv4l2.
>
>Murali Karicheri
>Software Design Engineer
>Texas Instruments Inc.
>Germantown, MD 20874
>phone: 301-407-9583
>email: m-karicheri2@ti.com
>
>>-----Original Message-----
>>From: Hans Verkuil [mailto:hverkuil@xs4all.nl]
>>Sent: Wednesday, November 18, 2009 2:33 AM
>>To: Mauro Carvalho Chehab
>>Cc: Karicheri, Muralidharan; linux-media@vger.kernel.org
>>Subject: Re: Help in adding documentation
>>
>>On Wednesday 18 November 2009 08:24:13 Mauro Carvalho Chehab wrote:
>>> Hans Verkuil wrote:
>>> > On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
>>> >> Karicheri, Muralidharan escreveu:
>>> >>> Mauro,
>>> >>>
>>> >>> Thanks to your help, I could finish my documentation today.
>>> >>>
>>> >>> But I have another issue with the v4l2-apps.
>>> >>>
>>> >>> When I do make apps, it doesn't seem to build. I get the following
>>error
>>> >>> logs... Is this broken?
>>> >> Well... no, it is not really broken, but the build system for v4l2-
>>apps
>>> >> needs serious improvements. There are some know issues on it:
>>> >> 	- It doesn't check/warn if you don't have all the dependencies
>>> >> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
>>> >> 	   that aren't available per default when gcc is installed - I
>>> >> 	   think the other files there are ok);
>>> >> 	- make only works fine when calling on certain directories (it
>used
>>to work
>>> >> 	  fine if you call it from /v4l2-apps/*) - but, since some
>patch, it
>>now requires
>>> >> 	  that you call make from /v4l2-apps, in order to create v4l2-
>>apps/include.
>>> >> 	  After having it created, make can be called from a /v4l2-apps
>>subdir;
>>> >> 	- for some places (libv4l - maybe there are other places?), you
>need
>>to
>>> >> 	  have the latest headers installed, as it doesn't use the one
>at the
>>tree.
>>> >> 	- qv4l2 only compiles with qt3.
>>> >
>>> > I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no time
>>to work
>>> > on a series of patches to merge it in the main repo. And it is missing
>>string
>>> > control support.
>>> >
>>> > If anyone is interested, then feel free to do that work. This new qt4
>>version
>>> > is much better than the qt3 version.
>>>
>>> IMO, the better is to have both versions on separate dirs, and let the
>>building
>>> system to check if qt4 is available. If so, build the qt4 version
>instead
>>of
>>> qt3 (a configure script, for example). Otherwise, warn users that it is
>>compiling
>>> a legacy application, due to the lack of the proper dependencies.
>>
>>I'm not going to maintain the qt3 version. Personally I think it is
>>pointless
>>having two tools for this and it only creates confusion and unnecessary
>>maintenance cost. Of course, all this is moot as long as the new version
>is
>>still unmerged.
>>
>>BTW: everything inside v4l2-apps should use the generated headers inside
>>v4l2-apps/include. These are generated from the headers in the tree and
>yes,
>>it would be nice if v4l2-apps/Makefile would have a proper dependency to
>>generate them. Now only the top-level Makefile knows about it. After that
>>include directory is generated you can do a make in v4l2-apps.
>>
>>But libv4l should use those headers and not the installed headers.
>>Something
>>may have been broken since when I last wrote that code.
>>
>>Regards,
>>
>>	Hans
>>
>>--
>>Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom
>
>--
>To unsubscribe from this list: send the line "unsubscribe linux-media" in
>the body of a message to majordomo@vger.kernel.org
>More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: Help in adding documentation

[Hans Verkuil]

On Thursday 19 November 2009 18:01:28 Karicheri, Muralidharan wrote:
> Hans,
>
> It is hard for me to get the v4l2-apps compile on my build environment.
> Unless someone can help me to resolve the build issue, I wouldn't be able
> to update the v4l2-apps or Alternately someone volunteer to add this
> support based on the API.

OK, the correct procedure to build the apps is this:

go to the top-level of your v4l-dvb repository and then run:

make distclean (just to be sure we start from scratch)
make apps

Now, I do get a compile error for decode_tm6000.c (patch pending in one of 
my pull requests), but by then v4l2-ctl.cpp has already been built.

I've also just discovered that the libv4l Makefiles are wrong: they contain 
a -I../../../include that should be a -I../../include. I think these 
sources have been moved up one level and the Makefiles were never updated. 
So if you don't have a recent videodev2.h in your /usr/include/linux 
directory, then you can get all sorts of compile errors.

I've added a patch for this to my pending 
http://www.linuxtv.org/hg/~hverkuil/v4l-dvb tree. As a workaround while 
this patch is not merged yet you can copy 
v4l2-apps/include/linux/videodev2.h to /usr/include/linux/videodev2.h.

If you still have problems compiling the v4l2-ctl.cpp tool, then you can 
also do it manually:

g++ -O2 -I../include -D_GNU_SOURCE -lm  v4l2-ctl.cpp   -o v4l2-ctl

Regards,

	Hans

>
> Thanks and regards,
>
> Murali Karicheri
> Software Design Engineer
> Texas Instruments Inc.
> Germantown, MD 20874
> phone: 301-407-9583
> email: m-karicheri2@ti.com
>
> >-----Original Message-----
> >From: linux-media-owner@vger.kernel.org [mailto:linux-media-
> >owner@vger.kernel.org] On Behalf Of Karicheri, Muralidharan
> >Sent: Thursday, November 19, 2009 11:26 AM
> >To: Hans Verkuil; Mauro Carvalho Chehab
> >Cc: linux-media@vger.kernel.org
> >Subject: RE: Help in adding documentation
> >
> >BTW,
> >
> >I don't know what is qt4/qt3 that you are referring to.
> >I see qv4l2 in the directory v4l2-apps/qv4l2.
> >
> >Murali Karicheri
> >Software Design Engineer
> >Texas Instruments Inc.
> >Germantown, MD 20874
> >phone: 301-407-9583
> >email: m-karicheri2@ti.com
> >
> >>-----Original Message-----
> >>From: Hans Verkuil [mailto:hverkuil@xs4all.nl]
> >>Sent: Wednesday, November 18, 2009 2:33 AM
> >>To: Mauro Carvalho Chehab
> >>Cc: Karicheri, Muralidharan; linux-media@vger.kernel.org
> >>Subject: Re: Help in adding documentation
> >>
> >>On Wednesday 18 November 2009 08:24:13 Mauro Carvalho Chehab wrote:
> >>> Hans Verkuil wrote:
> >>> > On Wednesday 18 November 2009 08:04:10 Mauro Carvalho Chehab wrote:
> >>> >> Karicheri, Muralidharan escreveu:
> >>> >>> Mauro,
> >>> >>>
> >>> >>> Thanks to your help, I could finish my documentation today.
> >>> >>>
> >>> >>> But I have another issue with the v4l2-apps.
> >>> >>>
> >>> >>> When I do make apps, it doesn't seem to build. I get the
> >>> >>> following
> >>
> >>error
> >>
> >>> >>> logs... Is this broken?
> >>> >>
> >>> >> Well... no, it is not really broken, but the build system for
> >>> >> v4l2-
> >>
> >>apps
> >>
> >>> >> needs serious improvements. There are some know issues on it:
> >>> >> 	- It doesn't check/warn if you don't have all the dependencies
> >>> >> 	  (qv4l2 and v4l2-sysfs-path require some development libraries
> >>> >> 	   that aren't available per default when gcc is installed - I
> >>> >> 	   think the other files there are ok);
> >>> >> 	- make only works fine when calling on certain directories (it
> >
> >used
> >
> >>to work
> >>
> >>> >> 	  fine if you call it from /v4l2-apps/*) - but, since some
> >
> >patch, it
> >
> >>now requires
> >>
> >>> >> 	  that you call make from /v4l2-apps, in order to create v4l2-
> >>
> >>apps/include.
> >>
> >>> >> 	  After having it created, make can be called from a /v4l2-apps
> >>
> >>subdir;
> >>
> >>> >> 	- for some places (libv4l - maybe there are other places?), you
> >
> >need
> >
> >>to
> >>
> >>> >> 	  have the latest headers installed, as it doesn't use the one
> >
> >at the
> >
> >>tree.
> >>
> >>> >> 	- qv4l2 only compiles with qt3.
> >>> >
> >>> > I have a qt4 version available in my v4l-dvb-qv4l2 tree. Just no
> >>> > time
> >>
> >>to work
> >>
> >>> > on a series of patches to merge it in the main repo. And it is
> >>> > missing
> >>
> >>string
> >>
> >>> > control support.
> >>> >
> >>> > If anyone is interested, then feel free to do that work. This new
> >>> > qt4
> >>
> >>version
> >>
> >>> > is much better than the qt3 version.
> >>>
> >>> IMO, the better is to have both versions on separate dirs, and let
> >>> the
> >>
> >>building
> >>
> >>> system to check if qt4 is available. If so, build the qt4 version
> >
> >instead
> >
> >>of
> >>
> >>> qt3 (a configure script, for example). Otherwise, warn users that it
> >>> is
> >>
> >>compiling
> >>
> >>> a legacy application, due to the lack of the proper dependencies.
> >>
> >>I'm not going to maintain the qt3 version. Personally I think it is
> >>pointless
> >>having two tools for this and it only creates confusion and unnecessary
> >>maintenance cost. Of course, all this is moot as long as the new
> >> version
> >
> >is
> >
> >>still unmerged.
> >>
> >>BTW: everything inside v4l2-apps should use the generated headers
> >> inside v4l2-apps/include. These are generated from the headers in the
> >> tree and
> >
> >yes,
> >
> >>it would be nice if v4l2-apps/Makefile would have a proper dependency
> >> to generate them. Now only the top-level Makefile knows about it.
> >> After that include directory is generated you can do a make in
> >> v4l2-apps.
> >>
> >>But libv4l should use those headers and not the installed headers.
> >>Something
> >>may have been broken since when I last wrote that code.
> >>
> >>Regards,
> >>
> >>	Hans
> >>
> >>--
> >>Hans Verkuil - video4linux developer - sponsored by TANDBERG Telecom
> >
> >--
> >To unsubscribe from this list: send the line "unsubscribe linux-media"
> > in the body of a message to majordomo@vger.kernel.org
> >More majordomo info at  http://vger.kernel.org/majordomo-info.html



-- 
Hans Verkuil - video4linux developer - sponsored by TANDBERG

RE: Help in adding documentation

[Karicheri, Muralidharan]

Mauro,

Is there specific way to create patch for this documentation?

Can I just do following commands and send one patch?

Baseline tree - v4l-dvb-base (original)
Changed tree -  v4l-dvb-change

diff -uNr v4l-dvb-base v4l-dvb-change >media-doc.patch

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Mauro Carvalho Chehab [mailto:mchehab@infradead.org]
>Sent: Tuesday, November 17, 2009 12:58 PM
>To: Karicheri, Muralidharan
>Cc: Hans Verkuil; linux-media@vger.kernel.org
>Subject: Re: Help in adding documentation
>
>Karicheri, Muralidharan escreveu:
>> Mauro,
>>
>> Thanks for your reply. I made progress after my email. My new file
>> is being processed by Makefile now. I have some issues with some
>> tags.
>>
>>> This probably means that videodev2.h has it defined, while you didn't
>have
>>
>> Do you mean videodev2.h.xml? I see there videodev2.h under linux/include.
>Do I need to copy my latest videodev2.h to that directory?
>
>videodev2.h.xml is generated automatically by Makefile, from videodev2.h.
>
>Basically, Makefile scripts will parse it, search for certain
>structs/enums/ioctls and
>generate videodev2.h.xml.
>
>What happens is that you likely declared the presets enum on videodev2.h,
>and the
>enum got detected, producing a <linkend> tag. However, as you didn't define
>the
>reference ID for that tag on your xml file, you got an error.
>>
>>> the
>>> link id created at the xml file you've created.
>>>
>>> You probably need a tag like:
>>>
>>> <table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
>>> <!-- your enum table -->
>>> </table>
>>>
>>>
>>> Cheers,
>>> Mauro
>>> --
>>> To unsubscribe from this list: send the line "unsubscribe linux-media"
>in
>>> the body of a message to majordomo@vger.kernel.org
>>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>>
>

Re: Help in adding documentation

[Mauro Carvalho Chehab]

Karicheri, Muralidharan wrote:
> Mauro,
> 
> Is there specific way to create patch for this documentation?
> 
> Can I just do following commands and send one patch?
> 
> Baseline tree - v4l-dvb-base (original)
> Changed tree -  v4l-dvb-change
> 
> diff -uNr v4l-dvb-base v4l-dvb-change >media-doc.patch

Well, this should work, however the better way is to clone the
tree with hg, modify it and do 
	hg diff >media-doc.patch

Mercurial is not that different from cvs, svn or git, so you can
also commit patches there and later export them for sending via email.

> 
> Murali Karicheri
> Software Design Engineer
> Texas Instruments Inc.
> Germantown, MD 20874
> phone: 301-407-9583
> email: m-karicheri2@ti.com
> 
>> -----Original Message-----
>> From: Mauro Carvalho Chehab [mailto:mchehab@infradead.org]
>> Sent: Tuesday, November 17, 2009 12:58 PM
>> To: Karicheri, Muralidharan
>> Cc: Hans Verkuil; linux-media@vger.kernel.org
>> Subject: Re: Help in adding documentation
>>
>> Karicheri, Muralidharan escreveu:
>>> Mauro,
>>>
>>> Thanks for your reply. I made progress after my email. My new file
>>> is being processed by Makefile now. I have some issues with some
>>> tags.
>>>
>>>> This probably means that videodev2.h has it defined, while you didn't
>> have
>>> Do you mean videodev2.h.xml? I see there videodev2.h under linux/include.
>> Do I need to copy my latest videodev2.h to that directory?
>>
>> videodev2.h.xml is generated automatically by Makefile, from videodev2.h.
>>
>> Basically, Makefile scripts will parse it, search for certain
>> structs/enums/ioctls and
>> generate videodev2.h.xml.
>>
>> What happens is that you likely declared the presets enum on videodev2.h,
>> and the
>> enum got detected, producing a <linkend> tag. However, as you didn't define
>> the
>> reference ID for that tag on your xml file, you got an error.
>>>> the
>>>> link id created at the xml file you've created.
>>>>
>>>> You probably need a tag like:
>>>>
>>>> <table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
>>>> <!-- your enum table -->
>>>> </table>
>>>>
>>>>
>>>> Cheers,
>>>> Mauro
>>>> --
>>>> To unsubscribe from this list: send the line "unsubscribe linux-media"
>> in
>>>> the body of a message to majordomo@vger.kernel.org
>>>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 

RE: Help in adding documentation

[Karicheri, Muralidharan]

Mauro,

Thanks. I will use diff method, since just for this I don't
have to learn yet another version control system :)

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com

>-----Original Message-----
>From: Mauro Carvalho Chehab [mailto:mchehab@infradead.org]
>Sent: Wednesday, November 18, 2009 2:48 PM
>To: Karicheri, Muralidharan
>Cc: Hans Verkuil; linux-media@vger.kernel.org
>Subject: Re: Help in adding documentation
>
>Karicheri, Muralidharan wrote:
>> Mauro,
>>
>> Is there specific way to create patch for this documentation?
>>
>> Can I just do following commands and send one patch?
>>
>> Baseline tree - v4l-dvb-base (original)
>> Changed tree -  v4l-dvb-change
>>
>> diff -uNr v4l-dvb-base v4l-dvb-change >media-doc.patch
>
>Well, this should work, however the better way is to clone the
>tree with hg, modify it and do
>	hg diff >media-doc.patch
>
>Mercurial is not that different from cvs, svn or git, so you can
>also commit patches there and later export them for sending via email.
>
>>
>> Murali Karicheri
>> Software Design Engineer
>> Texas Instruments Inc.
>> Germantown, MD 20874
>> phone: 301-407-9583
>> email: m-karicheri2@ti.com
>>
>>> -----Original Message-----
>>> From: Mauro Carvalho Chehab [mailto:mchehab@infradead.org]
>>> Sent: Tuesday, November 17, 2009 12:58 PM
>>> To: Karicheri, Muralidharan
>>> Cc: Hans Verkuil; linux-media@vger.kernel.org
>>> Subject: Re: Help in adding documentation
>>>
>>> Karicheri, Muralidharan escreveu:
>>>> Mauro,
>>>>
>>>> Thanks for your reply. I made progress after my email. My new file
>>>> is being processed by Makefile now. I have some issues with some
>>>> tags.
>>>>
>>>>> This probably means that videodev2.h has it defined, while you didn't
>>> have
>>>> Do you mean videodev2.h.xml? I see there videodev2.h under
>linux/include.
>>> Do I need to copy my latest videodev2.h to that directory?
>>>
>>> videodev2.h.xml is generated automatically by Makefile, from videodev2.h.
>>>
>>> Basically, Makefile scripts will parse it, search for certain
>>> structs/enums/ioctls and
>>> generate videodev2.h.xml.
>>>
>>> What happens is that you likely declared the presets enum on videodev2.h,
>>> and the
>>> enum got detected, producing a <linkend> tag. However, as you didn't
>define
>>> the
>>> reference ID for that tag on your xml file, you got an error.
>>>>> the
>>>>> link id created at the xml file you've created.
>>>>>
>>>>> You probably need a tag like:
>>>>>
>>>>> <table pgwide="1" frame="none" id="v4l2-dv-enum-presets">
>>>>> <!-- your enum table -->
>>>>> </table>
>>>>>
>>>>>
>>>>> Cheers,
>>>>> Mauro
>>>>> --
>>>>> To unsubscribe from this list: send the line "unsubscribe linux-media"
>>> in
>>>>> the body of a message to majordomo@vger.kernel.org
>>>>> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>>
>

Help in adding documentation

[Karicheri, Muralidharan]

Hi Mauro,

Is there some instructions on adding new sections in the v4l2 documentation. I had been struggling yesterday to add my documentation for video timing API. It is easy to make minor documentation changes. But since I am adding new ioctls, Looks like I need to create vidioc-<xxx>.xml under DoCBook/v4l/ directory since media-specs/Makefile is generating videodev2.h.xml automatically (I learned it in the hard way). I have added the IOCTL name in media-specs/Makefile and also added the structure name. But somehow, the videodev2.h.xml file doesn't show my structure types documented in vidioc-<xxx>.xml. Any idea what could be wrong?

Murali Karicheri
Software Design Engineer
Texas Instruments Inc.
Germantown, MD 20874
phone: 301-407-9583
email: m-karicheri2@ti.com