Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e383ce07 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] get rid of a number of problems at the cross references 

As warned by linuxdoc[1] tool, using:

$ for i in $(git grep kernel-doc Documentation/media/kapi/|cut -d: -f4); do kernel-lintdoc --sloppy $i; done

    include/media/v4l2-dev.h:118 :WARN: function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
    include/media/v4l2-mc.h:56 [kernel-doc WARN] : enum name from comment differs:  if_vid_dec_index <--> if_vid_dec_pad_index
    include/media/v4l2-mc.h:71 [kernel-doc WARN] : enum name from comment differs:  if_aud_dec_index <--> if_aud_dec_pad_index
    include/media/v4l2-mem2mem.h:396 [kernel-doc WARN] : function name from comment differs:  v4l2_m2m_num_src_bufs_ready <--> v4l2_m2m_num_dst_bufs_ready
    drivers/media/dvb-core/dvb_math.h:28 [kernel-doc WARN] : function name from comment differs:  cintlog2 <--> intlog2
    include/media/v4l2-subdev.h:215 [kernel-doc WARN] : struct name from comment differs:  s_radio <--> v4l2_subdev_tuner_ops
    include/media/v4l2-subdev.h:890 [kernel-doc WARN] : function name from comment differs:  v4l2_set_subdevdata <--> v4l2_set_subdev_hostdata
    include/media/v4l2-subdev.h:901 [kernel-doc WARN] : function name from comment differs:  v4l2_get_subdevdata <--> v4l2_get_subdev_hostdata
    drivers/media/dvb-core/dvb_ringbuffer.h:196 [kernel-doc WARN] : function name from comment differs:  dvb_ringbuffer_writeuser <--> dvb_ringbuffer_write_user
    include/media/videobuf2-core.h:399 [kernel-doc WARN] : struct name from comment differs:  vb2_ops <--> vb2_buf_ops
    include/media/media-entity.h:132 [kernel-doc ERROR] : duplicate parameter definition 'source'
    include/media/media-entity.h:477 [kernel-doc WARN] : function name from comment differs:  media_entity_enum_test <--> media_entity_enum_test_and_set
    include/media/media-entity.h:535 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_pad
    include/media/media-entity.h:544 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_link
    include/media/media-entity.h:553 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_intf
    include/media/media-entity.h:562 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> intf_to_devnode
    include/media/rc-core.h:234 [kernel-doc WARN] : function name from comment differs:  rc_open <--> rc_close
    include/media/v4l2-ctrls.h:397 [kernel-doc WARN] : missing initial short description of 'v4l2_ctrl_handler_init'
    include/media/v4l2-dev.h:118 [kernel-doc WARN] : function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
    include/media/v4l2-event.h:225 [kernel-doc WARN] : missing initial short description of 'v4l2_src_change_event_subscribe'

[1] https://return42.github.io/linuxdoc/linux.html



The above are real issues at the documentation. On several cases,
caused by cut-and-paste.

 Fix them.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent c2b66caf

Documentation/media/kapi/v4l2-dev.rst

+1 −1
Original line number Diff line number Diff line
@@ -173,7 +173,7 @@ The implementation of a hotplug disconnect should also take the lock from 
using :c:type:`video_device`->queue->lock, then you have to first lock

:c:type:`video_device`->queue->lock followed by :c:type:`video_device`->lock.

That way you can be sure no ioctl is running when you call

:c:type:`v4l2_device_disconnect`.

:c:func:`v4l2_device_disconnect`.



Video device registration

-------------------------

drivers/media/dvb-core/dvb_math.h

+1 −1
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ 
#include <linux/types.h>



/**

 * cintlog2 - computes log2 of a value; the result is shifted left by 24 bits

 * intlog2 - computes log2 of a value; the result is shifted left by 24 bits

 *

 * @value: The value (must be != 0)

 *

drivers/media/dvb-core/dvb_ringbuffer.h

+1 −1
Original line number Diff line number Diff line
@@ -193,7 +193,7 @@ extern ssize_t dvb_ringbuffer_write(struct dvb_ringbuffer *rbuf, const u8 *buf, 
				    size_t len);



/**

 * dvb_ringbuffer_writeuser - Writes a buffer received via an user pointer

 * dvb_ringbuffer_write_user - Writes a buffer received via an user pointer

 *

 * @rbuf: pointer to struct dvb_ringbuffer

 * @buf: pointer to the buffer where the data will be read

include/media/media-entity.h

+7 −6
Original line number Diff line number Diff line
@@ -129,7 +129,7 @@ struct media_pipeline { 
 *		an interface.

 * @gobj1:	Part of a union. Used to get the pointer for the second

 *		graph_object of the link.

 * @source:	Part of a union. Used only if the second object (gobj1) is

 * @sink:	Part of a union. Used only if the second object (gobj1) is

 *		a pad. In that case, it represents the sink pad.

 * @entity:	Part of a union. Used only if the second object (gobj1) is

 *		an entity.
@@ -474,7 +474,8 @@ static inline bool media_entity_enum_test(struct media_entity_enum *ent_enum, 
}



/**

 * media_entity_enum_test - Test whether the entity is marked, and mark it

 * media_entity_enum_test_and_set - Test whether the entity is marked,

 *	and mark it

 *

 * @ent_enum: Entity enumeration

 * @entity: Entity to be tested
@@ -532,7 +533,7 @@ static inline bool media_entity_enum_intersects( 
		container_of(gobj, struct media_entity, graph_obj)



/**

 * gobj_to_entity - returns the struct &media_pad pointer from the

 * gobj_to_pad - returns the struct &media_pad pointer from the

 *	@gobj contained on it.

 *

 * @gobj: Pointer to the struct &media_gobj graph object
@@ -541,7 +542,7 @@ static inline bool media_entity_enum_intersects( 
		container_of(gobj, struct media_pad, graph_obj)



/**

 * gobj_to_entity - returns the struct &media_link pointer from the

 * gobj_to_link - returns the struct &media_link pointer from the

 *	@gobj contained on it.

 *

 * @gobj: Pointer to the struct &media_gobj graph object
@@ -550,7 +551,7 @@ static inline bool media_entity_enum_intersects( 
		container_of(gobj, struct media_link, graph_obj)



/**

 * gobj_to_entity - returns the struct &media_interface pointer from the

 * gobj_to_intf - returns the struct &media_interface pointer from the

 *	@gobj contained on it.

 *

 * @gobj: Pointer to the struct &media_gobj graph object
@@ -559,7 +560,7 @@ static inline bool media_entity_enum_intersects( 
		container_of(gobj, struct media_interface, graph_obj)



/**

 * gobj_to_entity - returns the struct media_intf_devnode pointer from the

 * intf_to_devnode - returns the struct media_intf_devnode pointer from the

 *	@intf contained on it.

 *

 * @intf: Pointer to struct &media_intf_devnode

include/media/rc-core.h

+1 −1
Original line number Diff line number Diff line
@@ -231,7 +231,7 @@ void rc_unregister_device(struct rc_dev *dev); 
int rc_open(struct rc_dev *rdev);



/**

 * rc_open - Closes a RC device

 * rc_close - Closes a RC device

 *

 * @rdev: pointer to struct rc_dev.

 */