[RFC PATCH] Rename video_device et al to v4l2_devnode

[RFC PATCH] Rename video_device et al to v4l2_devnode

[Hans Verkuil]

Most of the v4l2 framework has prefixes that start with v4l2_ except for
struct video_device in v4l2-dev.c. This name is becoming very confusing since
it closely resembles struct v4l2_device. Since video_device really represents
a v4l2 device node I propose to rename it to v4l2_devnode and rename the
v4l2-dev.[ch] to v4l2-devnode.[ch].
 
To make the transition easier I created a v4l2-dev.h that includes the new
v4l2-devnode.h and #defines the old names to the new names.
 
I also updated the documentation to reflect the new header and naming convention.

The patches are here:

http://git.linuxtv.org/hverkuil/v4l-dvb.git?a=shortlog;h=refs/heads/v4l2-devnode

Hans Verkuil (18):
      v4l2-devnode: renamed from v4l2-dev
      videodev2.h: update comment
      v4l2 core: use v4l2-devnode.h instead of v4l2-dev.h
      v4l2: rename to_video_device to v4l2_devnode_from_device
      v4l2: rename video_device_alloc to v4l2_devnode_alloc
      v4l2: rename video_device_release_empty to v4l2_devnode_release_empty
      v4l2: rename video_device_release to v4l2_devnode_release
      v4l2: rename video_device_node_name to v4l2_devnode_name
      v4l2: rename video_register_device to v4l2_devnode_register
      v4l2: rename video_unregister_device to v4l2_devnode_unregister
      v4l2: rename video_is_registered to v4l2_devnode_is_registered
      v4l2: rename video_get/set_drvdata to v4l2_devnode_get/set_drvdata
      v4l2: rename video_devdata to v4l2_devnode_from_file
      v4l2: rename video_drvdata to v4l2_drvdata_from_file
      v4l2: rename video_device to v4l2_devnode
      tea575x: convert to v4l2-devnode.h
      v4l2: include v4l2-devnode.h instead of v4l2-dev.h
      v4l2: issue warning if v4l2-dev.h is included

After converting all drivers I added a warning to v4l2-dev.h when it is used.
This header can be removed completely after this series has been merged in the
mainline 2.6.37 kernel.

It's all pretty trivial but I think the new names are much more understandable
and fit well within the v4l2 framework API.

Comments?

	Hans

-- 
Hans Verkuil - video4linux developer - sponsored by TANDBERG, part of Cisco

Re: [RFC PATCH] Rename video_device et al to v4l2_devnode

[Hans Verkuil]

On Sunday, September 26, 2010 14:17:48 Andy Walls wrote:
> Sounds good to me.
> 
> I'm not to sure why you even bothered with the backward compat on the names.  I think it can only lead to trouble; but it does make merging out standing patchsets easier I guess.

It made the patches easier to do. Otherwise I would have to make one huge patch. Also
upstream merging should be simplified if someone added new v4l drivers to staging that
we don't have in our tree yet. Once it is upstreamed the compat header will be removed.

> 
> I haven't looked at the patchset, are there any other users outside the drivers/media tree?

UVC gadget drivers in usb/gadget and a v4l2 driver in sound/ (a radio tuner that's
part of a sound card).

And the v4l2 drivers in drivers/staging of course.

Regards,

	Hans

> 
> R,
> Andy 
> 
> Hans Verkuil <hverkuil@xs4all.nl> wrote:
> 
> >Most of the v4l2 framework has prefixes that start with v4l2_ except for
> >struct video_device in v4l2-dev.c. This name is becoming very confusing since
> >it closely resembles struct v4l2_device. Since video_device really represents
> >a v4l2 device node I propose to rename it to v4l2_devnode and rename the
> >v4l2-dev.[ch] to v4l2-devnode.[ch].
> > 
> >To make the transition easier I created a v4l2-dev.h that includes the new
> >v4l2-devnode.h and #defines the old names to the new names.
> > 
> >I also updated the documentation to reflect the new header and naming convention.
> >
> >The patches are here:
> >
> >http://git.linuxtv.org/hverkuil/v4l-dvb.git?a=shortlog;h=refs/heads/v4l2-devnode
> >
> >Hans Verkuil (18):
> >      v4l2-devnode: renamed from v4l2-dev
> >      videodev2.h: update comment
> >      v4l2 core: use v4l2-devnode.h instead of v4l2-dev.h
> >      v4l2: rename to_video_device to v4l2_devnode_from_device
> >      v4l2: rename video_device_alloc to v4l2_devnode_alloc
> >      v4l2: rename video_device_release_empty to v4l2_devnode_release_empty
> >      v4l2: rename video_device_release to v4l2_devnode_release
> >      v4l2: rename video_device_node_name to v4l2_devnode_name
> >      v4l2: rename video_register_device to v4l2_devnode_register
> >      v4l2: rename video_unregister_device to v4l2_devnode_unregister
> >      v4l2: rename video_is_registered to v4l2_devnode_is_registered
> >      v4l2: rename video_get/set_drvdata to v4l2_devnode_get/set_drvdata
> >      v4l2: rename video_devdata to v4l2_devnode_from_file
> >      v4l2: rename video_drvdata to v4l2_drvdata_from_file
> >      v4l2: rename video_device to v4l2_devnode
> >      tea575x: convert to v4l2-devnode.h
> >      v4l2: include v4l2-devnode.h instead of v4l2-dev.h
> >      v4l2: issue warning if v4l2-dev.h is included
> >
> >After converting all drivers I added a warning to v4l2-dev.h when it is used.
> >This header can be removed completely after this series has been merged in the
> >mainline 2.6.37 kernel.
> >
> >It's all pretty trivial but I think the new names are much more understandable
> >and fit well within the v4l2 framework API.
> >
> >Comments?
> >
> >	Hans
> >
> 
> 

-- 
Hans Verkuil - video4linux developer - sponsored by TANDBERG, part of Cisco

Re: [RFC PATCH] Rename video_device et al to v4l2_devnode

[Andy Walls]

Sounds good to me.

I'm not to sure why you even bothered with the backward compat on the names.  I think it can only lead to trouble; but it does make merging out standing patchsets easier I guess.

I haven't looked at the patchset, are there any other users outside the drivers/media tree?

R,
Andy 

Hans Verkuil <hverkuil@xs4all.nl> wrote:

>Most of the v4l2 framework has prefixes that start with v4l2_ except for
>struct video_device in v4l2-dev.c. This name is becoming very confusing since
>it closely resembles struct v4l2_device. Since video_device really represents
>a v4l2 device node I propose to rename it to v4l2_devnode and rename the
>v4l2-dev.[ch] to v4l2-devnode.[ch].
> 
>To make the transition easier I created a v4l2-dev.h that includes the new
>v4l2-devnode.h and #defines the old names to the new names.
> 
>I also updated the documentation to reflect the new header and naming convention.
>
>The patches are here:
>
>http://git.linuxtv.org/hverkuil/v4l-dvb.git?a=shortlog;h=refs/heads/v4l2-devnode
>
>Hans Verkuil (18):
>      v4l2-devnode: renamed from v4l2-dev
>      videodev2.h: update comment
>      v4l2 core: use v4l2-devnode.h instead of v4l2-dev.h
>      v4l2: rename to_video_device to v4l2_devnode_from_device
>      v4l2: rename video_device_alloc to v4l2_devnode_alloc
>      v4l2: rename video_device_release_empty to v4l2_devnode_release_empty
>      v4l2: rename video_device_release to v4l2_devnode_release
>      v4l2: rename video_device_node_name to v4l2_devnode_name
>      v4l2: rename video_register_device to v4l2_devnode_register
>      v4l2: rename video_unregister_device to v4l2_devnode_unregister
>      v4l2: rename video_is_registered to v4l2_devnode_is_registered
>      v4l2: rename video_get/set_drvdata to v4l2_devnode_get/set_drvdata
>      v4l2: rename video_devdata to v4l2_devnode_from_file
>      v4l2: rename video_drvdata to v4l2_drvdata_from_file
>      v4l2: rename video_device to v4l2_devnode
>      tea575x: convert to v4l2-devnode.h
>      v4l2: include v4l2-devnode.h instead of v4l2-dev.h
>      v4l2: issue warning if v4l2-dev.h is included
>
>After converting all drivers I added a warning to v4l2-dev.h when it is used.
>This header can be removed completely after this series has been merged in the
>mainline 2.6.37 kernel.
>
>It's all pretty trivial but I think the new names are much more understandable
>and fit well within the v4l2 framework API.
>
>Comments?
>
>	Hans
>
>-- 
>Hans Verkuil - video4linux developer - sponsored by TANDBERG, part of Cisco
>--
>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