While automating the CI, I found the following kernel-doc errors.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
Ricardo Ribalda (17):
media: mediatek: vcodec: Fix kerneldoc warnings
media: videodev2.h: Fix kerneldoc
media: media-entity.h: Fix kerneldoc
media: cec.h: Fix kerneldoc
media: pci: dt315.h: Fix kerneldoc
media: i2c: css-quirk.h: Fix kerneldoc
media: i2c: adv748: Fix kerneldoc
media: mediatek: jpeg: Fix kerneldoc
media: mediatek: vcodec: Fix kerneldoc
media: verisilicon: Fix kerneldoc
media: qcom: venus: Fix kerneldoc
media: samsung: exynos4-is: Fix kerneldoc
media: samsung: s5p-mfc: Fix kerneldoc
media: dvb-usb: Fix kerneldoc
media: ipu3: Fix kerneldoc
media: staging: meson: Fix kerneldoc
linux: v4l2-vp9.h: Fix kerneldoc
drivers/media/i2c/adv748x/adv748x.h | 1 -
drivers/media/i2c/ccs/ccs-quirk.h | 8 +++---
drivers/media/pci/dt3155/dt3155.h | 1 -
.../media/platform/mediatek/jpeg/mtk_jpeg_core.h | 1 -
.../mediatek/vcodec/decoder/mtk_vcodec_dec.h | 1 -
.../mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c | 1 -
.../vcodec/decoder/vdec/vdec_vp9_req_lat_if.c | 1 -
.../platform/mediatek/vcodec/decoder/vdec_vpu_if.h | 1 -
.../mediatek/vcodec/encoder/mtk_vcodec_enc.h | 1 -
drivers/media/platform/qcom/venus/core.h | 1 -
.../media/platform/samsung/exynos4-is/fimc-lite.h | 3 --
.../platform/samsung/s5p-mfc/s5p_mfc_common.h | 1 -
drivers/media/platform/verisilicon/hantro.h | 1 -
drivers/media/usb/dvb-usb/dvb-usb.h | 2 --
.../staging/media/ipu3/include/uapi/intel-ipu3.h | 3 --
drivers/staging/media/meson/vdec/vdec.h | 1 -
include/media/cec.h | 2 --
include/media/media-entity.h | 4 ---
include/media/v4l2-vp9.h | 6 +++-
include/uapi/linux/videodev2.h | 32 +++++++++++-----------
20 files changed, 25 insertions(+), 47 deletions(-)
---
base-commit: 615d300648869c774bd1fe54b4627bb0c20faed4
change-id: 20240126-gix-mtk-warnings-7c70f653717b
Best regards,
--
Ricardo Ribalda <[email protected]>
These fields seems to be gone:
drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c:57: warning: Excess struct member 'wait_key_frame' description in 'vdec_vp8_slice_info'
drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c:166: warning: Excess struct member 'mv_joint' description in 'vdec_vp9_slice_counts_map'
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c | 1 -
.../media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c | 1 -
2 files changed, 2 deletions(-)
diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
index f64b21c07169..f677e499fefa 100644
--- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
+++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
@@ -37,7 +37,6 @@
* @bs_sz: bitstream size
* @resolution_changed:resolution change flag 1 - changed, 0 - not change
* @frame_header_type: current frame header type
- * @wait_key_frame: wait key frame coming
* @crc: used to check whether hardware's status is right
* @reserved: reserved, currently unused
*/
diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
index 69d37b93bd35..cf48d09b78d7 100644
--- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
+++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
@@ -141,7 +141,6 @@ struct vdec_vp9_slice_frame_counts {
* @skip: skip counts.
* @y_mode: Y prediction mode counts.
* @filter: interpolation filter counts.
- * @mv_joint: motion vector joint counts.
* @sign: motion vector sign counts.
* @classes: motion vector class counts.
* @class0: motion vector class0 bit counts.
--
2.43.0.429.g432eaa2c6b-goog
Named nested unions need their prefix:
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions
Signed-off-by: Ricardo Ribalda <[email protected]>
---
include/uapi/linux/videodev2.h | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/include/uapi/linux/videodev2.h b/include/uapi/linux/videodev2.h
index 68e7ac178cc2..a8015e5e7fa4 100644
--- a/include/uapi/linux/videodev2.h
+++ b/include/uapi/linux/videodev2.h
@@ -1041,13 +1041,13 @@ struct v4l2_requestbuffers {
* struct v4l2_plane - plane info for multi-planar buffers
* @bytesused: number of bytes occupied by data in the plane (payload)
* @length: size of this plane (NOT the payload) in bytes
- * @mem_offset: when memory in the associated struct v4l2_buffer is
+ * @m.mem_offset: when memory in the associated struct v4l2_buffer is
* V4L2_MEMORY_MMAP, equals the offset from the start of
* the device memory for this plane (or is a "cookie" that
* should be passed to mmap() called on the video node)
- * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
+ * @m.userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
* pointing to this plane
- * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
+ * @m.fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
* descriptor associated with this plane
* @m: union of @mem_offset, @userptr and @fd
* @data_offset: offset in the plane to the start of data; usually 0,
@@ -1085,14 +1085,14 @@ struct v4l2_plane {
* @sequence: sequence count of this frame
* @memory: enum v4l2_memory; the method, in which the actual video data is
* passed
- * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
+ * @m.offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
* offset from the start of the device memory for this plane,
* (or a "cookie" that should be passed to mmap() as offset)
- * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
+ * @m.userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
* a userspace pointer pointing to this buffer
- * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
+ * @m.fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
* a userspace file descriptor associated with this buffer
- * @planes: for multiplanar buffers; userspace pointer to the array of plane
+ * @m.planes: for multiplanar buffers; userspace pointer to the array of plane
* info structs for this buffer
* @m: union of @offset, @userptr, @planes and @fd
* @length: size in bytes of the buffer (NOT its payload) for single-plane
@@ -2423,15 +2423,15 @@ struct v4l2_meta_format {
/**
* struct v4l2_format - stream data format
- * @type: enum v4l2_buf_type; type of the data stream
- * @pix: definition of an image format
- * @pix_mp: definition of a multiplanar image format
- * @win: definition of an overlaid image
- * @vbi: raw VBI capture or output parameters
- * @sliced: sliced VBI capture or output parameters
- * @raw_data: placeholder for future extensions and custom formats
- * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr, @meta
- * and @raw_data
+ * @type: enum v4l2_buf_type; type of the data stream
+ * @fmt.pix: definition of an image format
+ * @fmt.pix_mp: definition of a multiplanar image format
+ * @fmt.win: definition of an overlaid image
+ * @fmt.vbi: raw VBI capture or output parameters
+ * @fmt.sliced: sliced VBI capture or output parameters
+ * @fmt.raw_data: placeholder for future extensions and custom formats
+ * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr,
+ * @meta and @raw_data
*/
struct v4l2_format {
__u32 type;
--
2.43.0.429.g432eaa2c6b-goog
The fields are gone, remove their documentation.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
include/media/cec.h | 2 --
1 file changed, 2 deletions(-)
diff --git a/include/media/cec.h b/include/media/cec.h
index d77982685116..10c9cf6058b7 100644
--- a/include/media/cec.h
+++ b/include/media/cec.h
@@ -224,8 +224,6 @@ struct cec_adap_ops {
* @notifier: CEC notifier
* @pin: CEC pin status struct
* @cec_dir: debugfs cec directory
- * @status_file: debugfs cec status file
- * @error_inj_file: debugfs cec error injection file
* @sequence: transmit sequence counter
* @input_phys: remote control input_phys name
*
--
2.43.0.429.g432eaa2c6b-goog
Kerneldoc does not seem to understand that embed doc:
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk'
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk'
drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk'
Convert into a standard doc.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h
index 0b1a64958d71..392c97109617 100644
--- a/drivers/media/i2c/ccs/ccs-quirk.h
+++ b/drivers/media/i2c/ccs/ccs-quirk.h
@@ -28,11 +28,11 @@ struct ccs_sensor;
* @reg_access: Register access quirk. The quirk may divert the access
* to another register, or no register at all.
*
- * @write: Is this read (false) or write (true) access?
- * @reg: Pointer to the register to access
- * @value: Register value, set by the caller on write, or
+ * -write: Is this read (false) or write (true) access?
+ * -reg: Pointer to the register to access
+ * -val: Register value, set by the caller on write, or
* by the quirk on read
- * @return: 0 on success, -ENOIOCTLCMD if no register
+ * -return: 0 on success, -ENOIOCTLCMD if no register
* access may be done by the caller (default read
* value is zero), else negative error code on error
* @flags: Quirk flags
--
2.43.0.429.g432eaa2c6b-goog
The field is not part of the structure. Remove the doc.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/verisilicon/hantro.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/platform/verisilicon/hantro.h b/drivers/media/platform/verisilicon/hantro.h
index 6f5eb975d0e3..811260dc3c77 100644
--- a/drivers/media/platform/verisilicon/hantro.h
+++ b/drivers/media/platform/verisilicon/hantro.h
@@ -237,7 +237,6 @@ struct hantro_dev {
* @codec_ops: Set of operations related to codec mode.
* @postproc: Post-processing context.
* @h264_dec: H.264-decoding context.
- * @jpeg_enc: JPEG-encoding context.
* @mpeg2_dec: MPEG-2-decoding context.
* @vp8_dec: VP8-decoding context.
* @hevc_dec: HEVC-decoding context.
--
2.43.0.429.g432eaa2c6b-goog
Remove doc for missing field.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/qcom/venus/core.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
index 4a633261ece4..a39986ce79f1 100644
--- a/drivers/media/platform/qcom/venus/core.h
+++ b/drivers/media/platform/qcom/venus/core.h
@@ -428,7 +428,6 @@ enum venus_inst_modes {
* @error: an error returned during last HFI sync operation
* @session_error: a flag rised by HFI interface in case of session error
* @ops: HFI operations
- * @priv: a private for HFI operations callbacks
* @session_type: the type of the session (decoder or encoder)
* @hprop: a union used as a holder by get property
* @core_acquired: the Core has been acquired
--
2.43.0.429.g432eaa2c6b-goog
Remove documentation from missing field.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/staging/media/meson/vdec/vdec.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/staging/media/meson/vdec/vdec.h b/drivers/staging/media/meson/vdec/vdec.h
index 0906b8fb5cc6..258685177700 100644
--- a/drivers/staging/media/meson/vdec/vdec.h
+++ b/drivers/staging/media/meson/vdec/vdec.h
@@ -101,7 +101,6 @@ struct amvdec_core {
* @conf_esparser: mandatory call to let the vdec configure the ESPARSER
* @vififo_level: mandatory call to get the current amount of data
* in the VIFIFO
- * @use_offsets: mandatory call. Returns 1 if the VDEC supports vififo offsets
*/
struct amvdec_ops {
int (*start)(struct amvdec_session *sess);
--
2.43.0.429.g432eaa2c6b-goog
The field is gone, remove the documentation for it.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h b/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
index 8ba6e757e11a..8877eb39e807 100644
--- a/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
+++ b/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
@@ -144,7 +144,6 @@ struct mtk_jpegdec_clk {
* @jpegenc_irq: jpeg encode irq num
* @job_timeout_work: encode timeout workqueue
* @hw_param: jpeg encode hw parameters
- * @hw_rdy: record hw ready
* @hw_state: record hw state
* @hw_lock: spinlock protecting the hw device resource
*/
--
2.43.0.429.g432eaa2c6b-goog
The field is gone, remove the documentation.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/i2c/adv748x/adv748x.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/i2c/adv748x/adv748x.h b/drivers/media/i2c/adv748x/adv748x.h
index 6f90f78f58cf..d2b5e722e997 100644
--- a/drivers/media/i2c/adv748x/adv748x.h
+++ b/drivers/media/i2c/adv748x/adv748x.h
@@ -173,7 +173,6 @@ struct adv748x_afe {
*
* @endpoints: parsed device node endpoints for each port
*
- * @i2c_addresses: I2C Page addresses
* @i2c_clients: I2C clients for the page accesses
* @regmap: regmap configuration pages.
*
--
2.43.0.429.g432eaa2c6b-goog
Those fields have been removed. They do not need to be documented.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h | 1 -
drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h | 1 -
drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h | 1 -
3 files changed, 3 deletions(-)
diff --git a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
index ece27c880e50..1af075fc0194 100644
--- a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
+++ b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
@@ -39,7 +39,6 @@ struct vdec_fb {
/**
* struct mtk_video_dec_buf - Private data related to each VB2 buffer.
* @m2m_buf: M2M buffer
- * @list: link list
* @used: Capture buffer contain decoded frame data and keep in
* codec data structure
* @queued_in_vb2: Capture buffer is queue in vb2
diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
index fbb3f34a73f0..aa7d08afc2f4 100644
--- a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
+++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
@@ -22,7 +22,6 @@ struct mtk_vcodec_dec_ctx;
* in place of inst_addr in messages.
* @signaled : 1 - Host has received ack message from VPU, 0 - not received
* @ctx : context for v4l2 layer integration
- * @dev : platform device of VPU
* @wq : wait queue to wait VPU message ack
* @handler : ipi handler for each decoder
* @codec_type : use codec type to separate different codecs
diff --git a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
index 82246401ed4a..908d8179b2d2 100644
--- a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
+++ b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
@@ -26,7 +26,6 @@
/**
* struct mtk_video_enc_buf - Private data related to each VB2 buffer.
* @m2m_buf: M2M buffer
- * @list: list that buffer link to
* @param_change: Types of encode parameter change before encoding this
* buffer
* @enc_params: Encode parameters changed before encode this buffer
--
2.43.0.429.g432eaa2c6b-goog
Remove doc from missing fields.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/samsung/exynos4-is/fimc-lite.h | 3 ---
1 file changed, 3 deletions(-)
diff --git a/drivers/media/platform/samsung/exynos4-is/fimc-lite.h b/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
index ddf29e0b5b1c..2d96fb00a5c6 100644
--- a/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
+++ b/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
@@ -117,8 +117,6 @@ struct flite_buffer {
* @ctrl_handler: v4l2 control handler
* @test_pattern: test pattern controls
* @index: FIMC-LITE platform device index
- * @pipeline: video capture pipeline data structure
- * @pipeline_ops: media pipeline ops for the video node driver
* @slock: spinlock protecting this data structure and the hw registers
* @lock: mutex serializing video device and the subdev operations
* @clock: FIMC-LITE gate clock
@@ -134,7 +132,6 @@ struct flite_buffer {
* @active_buf_q: the queue head of buffers scheduled in hardware
* @vb_queue: vb2 buffers queue
* @buf_index: helps to keep track of the DMA start address register index
- * @active_buf_count: number of video buffers scheduled in hardware
* @frame_count: the captured frames counter
* @reqbufs_count: the number of buffers requested with REQBUFS ioctl
* @events: event info
--
2.43.0.429.g432eaa2c6b-goog
The fields seems to be documented twice.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
include/media/media-entity.h | 4 ----
1 file changed, 4 deletions(-)
diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 2b6cd343ee9e..c79176ed6299 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -337,10 +337,6 @@ enum media_entity_type {
* @info.dev: Contains device major and minor info.
* @info.dev.major: device node major, if the device is a devnode.
* @info.dev.minor: device node minor, if the device is a devnode.
- * @major: Devnode major number (zero if not applicable). Kept just
- * for backward compatibility.
- * @minor: Devnode minor number (zero if not applicable). Kept just
- * for backward compatibility.
*
* .. note::
*
--
2.43.0.429.g432eaa2c6b-goog
The field is gone, remove it.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/pci/dt3155/dt3155.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/pci/dt3155/dt3155.h b/drivers/media/pci/dt3155/dt3155.h
index c9ce79cb5566..ce1835d9691e 100644
--- a/drivers/media/pci/dt3155/dt3155.h
+++ b/drivers/media/pci/dt3155/dt3155.h
@@ -162,7 +162,6 @@
* @height: frame height
* @input: current input
* @sequence: frame counter
- * @stats: statistics structure
* @regs: local copy of mmio base register
* @csr2: local copy of csr2 register
* @config: local copy of config register
--
2.43.0.429.g432eaa2c6b-goog
Remove kerneldoc from missing fields.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/usb/dvb-usb/dvb-usb.h | 2 --
1 file changed, 2 deletions(-)
diff --git a/drivers/media/usb/dvb-usb/dvb-usb.h b/drivers/media/usb/dvb-usb/dvb-usb.h
index 0990aa4a17bb..cbb0541d4dc1 100644
--- a/drivers/media/usb/dvb-usb/dvb-usb.h
+++ b/drivers/media/usb/dvb-usb/dvb-usb.h
@@ -126,8 +126,6 @@ struct usb_data_stream_properties {
* @caps: capabilities of the DVB USB device.
* @pid_filter_count: number of PID filter position in the optional hardware
* PID-filter.
- * @num_frontends: number of frontends of the DVB USB adapter.
- * @frontend_ctrl: called to power on/off active frontend.
* @streaming_ctrl: called to start and stop the MPEG2-TS streaming of the
* device (not URB submitting/killing).
* This callback will be called without data URBs being active - data URBs
--
2.43.0.429.g432eaa2c6b-goog
Remove documentation from missing fields.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 3 ---
1 file changed, 3 deletions(-)
diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
index caa358e0bae4..4aa2797f5e3c 100644
--- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
+++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
@@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
* &ipu3_uapi_yuvp1_y_ee_nr_config
* @yds: y down scaler config. See &ipu3_uapi_yuvp1_yds_config
* @chnr: chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
- * @reserved1: reserved
* @yds2: y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
* @tcc: total color correction config as defined in struct
* &ipu3_uapi_yuvp2_tcc_static_config
- * @reserved2: reserved
* @anr: advanced noise reduction config.See &ipu3_uapi_anr_config
* @awb_fr: AWB filter response config. See ipu3_uapi_awb_fr_config
* @ae: auto exposure config As specified by &ipu3_uapi_ae_config
@@ -2724,7 +2722,6 @@ struct ipu3_uapi_obgrid_param {
* @acc_ae: 0 = no update, 1 = update.
* @acc_af: 0 = no update, 1 = update.
* @acc_awb: 0 = no update, 1 = update.
- * @__acc_osys: 0 = no update, 1 = update.
* @reserved3: Not used.
* @lin_vmem_params: 0 = no update, 1 = update.
* @tnr3_vmem_params: 0 = no update, 1 = update.
--
2.43.0.429.g432eaa2c6b-goog
Remove doc from missing fields.
Signed-off-by: Ricardo Ribalda <[email protected]>
---
drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
index 59450b324f7d..7e7e7b695b53 100644
--- a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
+++ b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
@@ -612,7 +612,6 @@ struct s5p_mfc_codec_ops {
* @chroma_dpb_size: dpb buffer size for chroma
* @me_buffer_size: size of the motion estimation buffer
* @tmv_buffer_size: size of temporal predictor motion vector buffer
- * @frame_type: used to force the type of the next encoded frame
* @ref_queue: list of the reference buffers for encoding
* @force_frame_type: encoder's frame type forcing control
* @ref_queue_cnt: number of the buffers in the reference list
--
2.43.0.429.g432eaa2c6b-goog
Kerneldoc cannot understand arrays defined like
v4l2_frame_symbol_counts.
Adding an asterisk to the name does do the trick.
Disable the kerneldoc notation for now, it is already ignored:
https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
include/media/v4l2-vp9.h:144: warning: Excess struct member 'partition' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'skip' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'intra_inter' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'tx32p' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'tx16p' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'tx8p' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'y_mode' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'uv_mode' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'comp' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'comp_ref' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'single_ref' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'mv_mode' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'filter' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'mv_joint' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'sign' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'classes' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'class0' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'bits' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'class0_fp' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'fp' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'class0_hp' description in 'v4l2_vp9_frame_symbol_counts'
include/media/v4l2-vp9.h:144: warning: Excess struct member 'hp' description in 'v4l2_vp9_frame_symbol_counts'
Signed-off-by: Ricardo Ribalda <[email protected]>
---
include/media/v4l2-vp9.h | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/include/media/v4l2-vp9.h b/include/media/v4l2-vp9.h
index 05478ad6d4ab..f0d80273bd61 100644
--- a/include/media/v4l2-vp9.h
+++ b/include/media/v4l2-vp9.h
@@ -83,7 +83,11 @@ struct v4l2_vp9_frame_context {
struct v4l2_vp9_frame_mv_context mv;
};
-/**
+/*
+ * NOTE: This is not a kerneldoc, because the (*name) notation confuses the
+ * parser.
+ */
+/*
* struct v4l2_vp9_frame_symbol_counts - pointers to arrays of symbol counts
*
* @partition: partition counts.
--
2.43.0.429.g432eaa2c6b-goog
On 1/26/24 15:16, Ricardo Ribalda wrote:
> These fields seems to be gone:
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c:57: warning: Excess struct member 'wait_key_frame' description in 'vdec_vp8_slice_info'
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c:166: warning: Excess struct member 'mv_joint' description in 'vdec_vp9_slice_counts_map'
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c | 1 -
> .../media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c | 1 -
> 2 files changed, 2 deletions(-)
>
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> index f64b21c07169..f677e499fefa 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> @@ -37,7 +37,6 @@
> * @bs_sz: bitstream size
> * @resolution_changed:resolution change flag 1 - changed, 0 - not change
> * @frame_header_type: current frame header type
> - * @wait_key_frame: wait key frame coming
> * @crc: used to check whether hardware's status is right
> * @reserved: reserved, currently unused
> */
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> index 69d37b93bd35..cf48d09b78d7 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> @@ -141,7 +141,6 @@ struct vdec_vp9_slice_frame_counts {
> * @skip: skip counts.
> * @y_mode: Y prediction mode counts.
> * @filter: interpolation filter counts.
> - * @mv_joint: motion vector joint counts.
> * @sign: motion vector sign counts.
> * @classes: motion vector class counts.
> * @class0: motion vector class0 bit counts.
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The fields seems to be documented twice.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
> ---
> include/media/media-entity.h | 4 ----
> 1 file changed, 4 deletions(-)
>
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
> * @info.dev: Contains device major and minor info.
> * @info.dev.major: device node major, if the device is a devnode.
> * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major: Devnode major number (zero if not applicable). Kept just
> - * for backward compatibility.
> - * @minor: Devnode minor number (zero if not applicable). Kept just
> - * for backward compatibility.
> *
> * .. note::
> *
>
I'd say that this is correct based on
https://patchwork.kernel.org/project/linux-media/patch/[email protected]/
Hans, can you please explain this message from you, on 2024-Jan-22, that I cannot find in the media patchwork:
Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
This is an automatic generated email to let you know that the following patch were queued:
Subject: media: media-entity.h: fix Excess kernel-doc description warnings
Author: Randy Dunlap <[email protected]>
Date: Fri Dec 22 21:07:07 2023 -0800
Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
Signed-off-by: Randy Dunlap <[email protected]>
Reviewed-by: Laurent Pinchart <[email protected]>
Signed-off-by: Sakari Ailus <[email protected]>
Signed-off-by: Hans Verkuil <[email protected]>
include/media/media-entity.h | 4 ----
1 file changed, 4 deletions(-)
---
diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 2b6cd343ee9e..c79176ed6299 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -337,10 +337,6 @@ enum media_entity_type {
* @info.dev: Contains device major and minor info.
* @info.dev.major: device node major, if the device is a devnode.
* @info.dev.minor: device node minor, if the device is a devnode.
- * @major: Devnode major number (zero if not applicable). Kept just
- * for backward compatibility.
- * @minor: Devnode minor number (zero if not applicable). Kept just
- * for backward compatibility.
*
* .. note::
*
Thanks.
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Named nested unions need their prefix:
> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Tested-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> include/uapi/linux/videodev2.h | 32 ++++++++++++++++----------------
> 1 file changed, 16 insertions(+), 16 deletions(-)
>
> diff --git a/include/uapi/linux/videodev2.h b/include/uapi/linux/videodev2.h
> index 68e7ac178cc2..a8015e5e7fa4 100644
> --- a/include/uapi/linux/videodev2.h
> +++ b/include/uapi/linux/videodev2.h
> @@ -1041,13 +1041,13 @@ struct v4l2_requestbuffers {
> * struct v4l2_plane - plane info for multi-planar buffers
> * @bytesused: number of bytes occupied by data in the plane (payload)
> * @length: size of this plane (NOT the payload) in bytes
> - * @mem_offset: when memory in the associated struct v4l2_buffer is
> + * @m.mem_offset: when memory in the associated struct v4l2_buffer is
> * V4L2_MEMORY_MMAP, equals the offset from the start of
> * the device memory for this plane (or is a "cookie" that
> * should be passed to mmap() called on the video node)
> - * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
> + * @m.userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
> * pointing to this plane
> - * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
> + * @m.fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
> * descriptor associated with this plane
> * @m: union of @mem_offset, @userptr and @fd
> * @data_offset: offset in the plane to the start of data; usually 0,
> @@ -1085,14 +1085,14 @@ struct v4l2_plane {
> * @sequence: sequence count of this frame
> * @memory: enum v4l2_memory; the method, in which the actual video data is
> * passed
> - * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
> + * @m.offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
> * offset from the start of the device memory for this plane,
> * (or a "cookie" that should be passed to mmap() as offset)
> - * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
> + * @m.userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
> * a userspace pointer pointing to this buffer
> - * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
> + * @m.fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
> * a userspace file descriptor associated with this buffer
> - * @planes: for multiplanar buffers; userspace pointer to the array of plane
> + * @m.planes: for multiplanar buffers; userspace pointer to the array of plane
> * info structs for this buffer
> * @m: union of @offset, @userptr, @planes and @fd
> * @length: size in bytes of the buffer (NOT its payload) for single-plane
> @@ -2423,15 +2423,15 @@ struct v4l2_meta_format {
>
> /**
> * struct v4l2_format - stream data format
> - * @type: enum v4l2_buf_type; type of the data stream
> - * @pix: definition of an image format
> - * @pix_mp: definition of a multiplanar image format
> - * @win: definition of an overlaid image
> - * @vbi: raw VBI capture or output parameters
> - * @sliced: sliced VBI capture or output parameters
> - * @raw_data: placeholder for future extensions and custom formats
> - * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr, @meta
> - * and @raw_data
> + * @type: enum v4l2_buf_type; type of the data stream
> + * @fmt.pix: definition of an image format
> + * @fmt.pix_mp: definition of a multiplanar image format
> + * @fmt.win: definition of an overlaid image
> + * @fmt.vbi: raw VBI capture or output parameters
> + * @fmt.sliced: sliced VBI capture or output parameters
> + * @fmt.raw_data: placeholder for future extensions and custom formats
> + * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr,
> + * @meta and @raw_data
> */
> struct v4l2_format {
> __u32 type;
>
--
#Randy
Hi Ricardo,
Thanks for the patchset.
On Fri, Jan 26, 2024 at 11:16:02PM +0000, Ricardo Ribalda wrote:
> The fields seems to be documented twice.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
> ---
> include/media/media-entity.h | 4 ----
> 1 file changed, 4 deletions(-)
>
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
> * @info.dev: Contains device major and minor info.
> * @info.dev.major: device node major, if the device is a devnode.
> * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major: Devnode major number (zero if not applicable). Kept just
> - * for backward compatibility.
> - * @minor: Devnode minor number (zero if not applicable). Kept just
> - * for backward compatibility.
A similar patch by Randy Dunlap was recently merged. You can drop this one.
> *
> * .. note::
> *
>
--
Kind regards,
Sakari Ailus
Hi Ricardo,
On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
> Kerneldoc cannot understand arrays defined like
> v4l2_frame_symbol_counts.
>
> Adding an asterisk to the name does do the trick.
>
> Disable the kerneldoc notation for now, it is already ignored:
> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
all.
Feel free to, but I can also give it a try.
--
Regards,
Sakari Ailus
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Kerneldoc does not seem to understand that embed doc:
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk'
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk'
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk'
>
Correct. It's never tried to understand that AFAIK.
> Convert into a standard doc.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h
> index 0b1a64958d71..392c97109617 100644
> --- a/drivers/media/i2c/ccs/ccs-quirk.h
> +++ b/drivers/media/i2c/ccs/ccs-quirk.h
> @@ -28,11 +28,11 @@ struct ccs_sensor;
> * @reg_access: Register access quirk. The quirk may divert the access
> * to another register, or no register at all.
> *
> - * @write: Is this read (false) or write (true) access?
> - * @reg: Pointer to the register to access
> - * @value: Register value, set by the caller on write, or
> + * -write: Is this read (false) or write (true) access?
> + * -reg: Pointer to the register to access
> + * -val: Register value, set by the caller on write, or
> * by the quirk on read
> - * @return: 0 on success, -ENOIOCTLCMD if no register
> + * -return: 0 on success, -ENOIOCTLCMD if no register
> * access may be done by the caller (default read
> * value is zero), else negative error code on error
> * @flags: Quirk flags
>
--
#Randy
Hi,
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc for missing field.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
> ---
> drivers/media/platform/qcom/venus/core.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
> index 4a633261ece4..a39986ce79f1 100644
> --- a/drivers/media/platform/qcom/venus/core.h
> +++ b/drivers/media/platform/qcom/venus/core.h
> @@ -428,7 +428,6 @@ enum venus_inst_modes {
> * @error: an error returned during last HFI sync operation
> * @session_error: a flag rised by HFI interface in case of session error
> * @ops: HFI operations
> - * @priv: a private for HFI operations callbacks
> * @session_type: the type of the session (decoder or encoder)
> * @hprop: a union used as a holder by get property
> * @core_acquired: the Core has been acquired
>
I don't understand this one. I do understand the patch above, but the in the struct,
I see:
unsigned long enc_codecs;
unsigned long dec_codecs;
unsigned int max_sessions_supported;
void *priv;
const struct hfi_ops *ops;
struct delayed_work work;
I'm just guessing, but maybe scripts/kernel-doc is confused....
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc from missing fields.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> index 59450b324f7d..7e7e7b695b53 100644
> --- a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> +++ b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> @@ -612,7 +612,6 @@ struct s5p_mfc_codec_ops {
> * @chroma_dpb_size: dpb buffer size for chroma
> * @me_buffer_size: size of the motion estimation buffer
> * @tmv_buffer_size: size of temporal predictor motion vector buffer
> - * @frame_type: used to force the type of the next encoded frame
> * @ref_queue: list of the reference buffers for encoding
> * @force_frame_type: encoder's frame type forcing control
> * @ref_queue_cnt: number of the buffers in the reference list
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is gone, remove the documentation.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/i2c/adv748x/adv748x.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/i2c/adv748x/adv748x.h b/drivers/media/i2c/adv748x/adv748x.h
> index 6f90f78f58cf..d2b5e722e997 100644
> --- a/drivers/media/i2c/adv748x/adv748x.h
> +++ b/drivers/media/i2c/adv748x/adv748x.h
> @@ -173,7 +173,6 @@ struct adv748x_afe {
> *
> * @endpoints: parsed device node endpoints for each port
> *
> - * @i2c_addresses: I2C Page addresses
> * @i2c_clients: I2C clients for the page accesses
> * @regmap: regmap configuration pages.
> *
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Those fields have been removed. They do not need to be documented.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h | 1 -
> drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h | 1 -
> drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h | 1 -
> 3 files changed, 3 deletions(-)
>
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> index ece27c880e50..1af075fc0194 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> @@ -39,7 +39,6 @@ struct vdec_fb {
> /**
> * struct mtk_video_dec_buf - Private data related to each VB2 buffer.
> * @m2m_buf: M2M buffer
> - * @list: link list
> * @used: Capture buffer contain decoded frame data and keep in
> * codec data structure
> * @queued_in_vb2: Capture buffer is queue in vb2
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> index fbb3f34a73f0..aa7d08afc2f4 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> @@ -22,7 +22,6 @@ struct mtk_vcodec_dec_ctx;
> * in place of inst_addr in messages.
> * @signaled : 1 - Host has received ack message from VPU, 0 - not received
> * @ctx : context for v4l2 layer integration
> - * @dev : platform device of VPU
> * @wq : wait queue to wait VPU message ack
> * @handler : ipi handler for each decoder
> * @codec_type : use codec type to separate different codecs
> diff --git a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> index 82246401ed4a..908d8179b2d2 100644
> --- a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> +++ b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> @@ -26,7 +26,6 @@
> /**
> * struct mtk_video_enc_buf - Private data related to each VB2 buffer.
> * @m2m_buf: M2M buffer
> - * @list: list that buffer link to
> * @param_change: Types of encode parameter change before encoding this
> * buffer
> * @enc_params: Encode parameters changed before encode this buffer
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove documentation from missing fields.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> index caa358e0bae4..4aa2797f5e3c 100644
> --- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> +++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> @@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
> * &ipu3_uapi_yuvp1_y_ee_nr_config
> * @yds: y down scaler config. See &ipu3_uapi_yuvp1_yds_config
> * @chnr: chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
> - * @reserved1: reserved
> * @yds2: y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
> * @tcc: total color correction config as defined in struct
> * &ipu3_uapi_yuvp2_tcc_static_config
> - * @reserved2: reserved
> * @anr: advanced noise reduction config.See &ipu3_uapi_anr_config
> * @awb_fr: AWB filter response config. See ipu3_uapi_awb_fr_config
> * @ae: auto exposure config As specified by &ipu3_uapi_ae_config
> @@ -2724,7 +2722,6 @@ struct ipu3_uapi_obgrid_param {
> * @acc_ae: 0 = no update, 1 = update.
> * @acc_af: 0 = no update, 1 = update.
> * @acc_awb: 0 = no update, 1 = update.
> - * @__acc_osys: 0 = no update, 1 = update.
> * @reserved3: Not used.
> * @lin_vmem_params: 0 = no update, 1 = update.
> * @tnr3_vmem_params: 0 = no update, 1 = update.
>
--
#Randy
On 1/27/24 10:40, Sakari Ailus wrote:
> Hi Randy,
>
> On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
>>
>>
>> On 1/26/24 15:16, Ricardo Ribalda wrote:
>>> The fields seems to be documented twice.
>>>
>>> Signed-off-by: Ricardo Ribalda <[email protected]>
>>> ---
>>> include/media/media-entity.h | 4 ----
>>> 1 file changed, 4 deletions(-)
>>>
>>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>>> index 2b6cd343ee9e..c79176ed6299 100644
>>> --- a/include/media/media-entity.h
>>> +++ b/include/media/media-entity.h
>>> @@ -337,10 +337,6 @@ enum media_entity_type {
>>> * @info.dev: Contains device major and minor info.
>>> * @info.dev.major: device node major, if the device is a devnode.
>>> * @info.dev.minor: device node minor, if the device is a devnode.
>>> - * @major: Devnode major number (zero if not applicable). Kept just
>>> - * for backward compatibility.
>>> - * @minor: Devnode minor number (zero if not applicable). Kept just
>>> - * for backward compatibility.
>>> *
>>> * .. note::
>>> *
>>>
>>
>> I'd say that this is correct based on
>> https://patchwork.kernel.org/project/linux-media/patch/[email protected]/
>>
Ah, I see. Thank you.
>>
>> Hans, can you please explain this message from you, on 2024-Jan-22, that
>> I cannot find in the media patchwork:
>
> It's in linuxtv.org Patchwork here
> <URL:https://patchwork.linuxtv.org/project/linux-media/patch/[email protected]/>
> and also in the media stage tree (as indicated by the state) but not yet in
> master AFAIU.
>
>>
>>
>> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
>>
>>
>>
>> This is an automatic generated email to let you know that the following patch were queued:
>>
>> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
>> Author: Randy Dunlap <[email protected]>
>> Date: Fri Dec 22 21:07:07 2023 -0800
>>
>> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
>>
>> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
>> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
>>
>> Signed-off-by: Randy Dunlap <[email protected]>
>> Reviewed-by: Laurent Pinchart <[email protected]>
>> Signed-off-by: Sakari Ailus <[email protected]>
>> Signed-off-by: Hans Verkuil <[email protected]>
>>
>> include/media/media-entity.h | 4 ----
>> 1 file changed, 4 deletions(-)
>>
>> ---
>>
>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>> index 2b6cd343ee9e..c79176ed6299 100644
>> --- a/include/media/media-entity.h
>> +++ b/include/media/media-entity.h
>> @@ -337,10 +337,6 @@ enum media_entity_type {
>> * @info.dev: Contains device major and minor info.
>> * @info.dev.major: device node major, if the device is a devnode.
>> * @info.dev.minor: device node minor, if the device is a devnode.
>> - * @major: Devnode major number (zero if not applicable). Kept just
>> - * for backward compatibility.
>> - * @minor: Devnode minor number (zero if not applicable). Kept just
>> - * for backward compatibility.
>> *
>> * .. note::
>> *
>>
>>
>>
>> Thanks.
>
--
#Randy
On 1/27/24 14:13, Randy Dunlap wrote:
> Hi,
>
> On 1/26/24 15:16, Ricardo Ribalda wrote:
>> Remove doc for missing field.
>>
>> Signed-off-by: Ricardo Ribalda <[email protected]>
>> ---
>> drivers/media/platform/qcom/venus/core.h | 1 -
>> 1 file changed, 1 deletion(-)
>>
>> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
>> index 4a633261ece4..a39986ce79f1 100644
>> --- a/drivers/media/platform/qcom/venus/core.h
>> +++ b/drivers/media/platform/qcom/venus/core.h
>> @@ -428,7 +428,6 @@ enum venus_inst_modes {
>> * @error: an error returned during last HFI sync operation
>> * @session_error: a flag rised by HFI interface in case of session error
>> * @ops: HFI operations
>> - * @priv: a private for HFI operations callbacks
>> * @session_type: the type of the session (decoder or encoder)
>> * @hprop: a union used as a holder by get property
>> * @core_acquired: the Core has been acquired
>>
>
> I don't understand this one. I do understand the patch above, but the in the struct,
> I see:
>
> unsigned long enc_codecs;
> unsigned long dec_codecs;
> unsigned int max_sessions_supported;
> void *priv;
> const struct hfi_ops *ops;
> struct delayed_work work;
>
> I'm just guessing, but maybe scripts/kernel-doc is confused....
>
Nope, I'm confused. The patch is correct.
Thanks.
Reviewed-by: Randy Dunlap <[email protected]>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc from missing fields.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/samsung/exynos4-is/fimc-lite.h | 3 ---
> 1 file changed, 3 deletions(-)
>
> diff --git a/drivers/media/platform/samsung/exynos4-is/fimc-lite.h b/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
> index ddf29e0b5b1c..2d96fb00a5c6 100644
> --- a/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
> +++ b/drivers/media/platform/samsung/exynos4-is/fimc-lite.h
> @@ -117,8 +117,6 @@ struct flite_buffer {
> * @ctrl_handler: v4l2 control handler
> * @test_pattern: test pattern controls
> * @index: FIMC-LITE platform device index
> - * @pipeline: video capture pipeline data structure
> - * @pipeline_ops: media pipeline ops for the video node driver
> * @slock: spinlock protecting this data structure and the hw registers
> * @lock: mutex serializing video device and the subdev operations
> * @clock: FIMC-LITE gate clock
> @@ -134,7 +132,6 @@ struct flite_buffer {
> * @active_buf_q: the queue head of buffers scheduled in hardware
> * @vb_queue: vb2 buffers queue
> * @buf_index: helps to keep track of the DMA start address register index
> - * @active_buf_count: number of video buffers scheduled in hardware
> * @frame_count: the captured frames counter
> * @reqbufs_count: the number of buffers requested with REQBUFS ioctl
> * @events: event info
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is gone, remove the documentation for it.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h b/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
> index 8ba6e757e11a..8877eb39e807 100644
> --- a/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
> +++ b/drivers/media/platform/mediatek/jpeg/mtk_jpeg_core.h
> @@ -144,7 +144,6 @@ struct mtk_jpegdec_clk {
> * @jpegenc_irq: jpeg encode irq num
> * @job_timeout_work: encode timeout workqueue
> * @hw_param: jpeg encode hw parameters
> - * @hw_rdy: record hw ready
> * @hw_state: record hw state
> * @hw_lock: spinlock protecting the hw device resource
> */
>
--
#Randy
Hi Randy,
On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
>
>
> On 1/26/24 15:16, Ricardo Ribalda wrote:
> > The fields seems to be documented twice.
> >
> > Signed-off-by: Ricardo Ribalda <[email protected]>
> > ---
> > include/media/media-entity.h | 4 ----
> > 1 file changed, 4 deletions(-)
> >
> > diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> > index 2b6cd343ee9e..c79176ed6299 100644
> > --- a/include/media/media-entity.h
> > +++ b/include/media/media-entity.h
> > @@ -337,10 +337,6 @@ enum media_entity_type {
> > * @info.dev: Contains device major and minor info.
> > * @info.dev.major: device node major, if the device is a devnode.
> > * @info.dev.minor: device node minor, if the device is a devnode.
> > - * @major: Devnode major number (zero if not applicable). Kept just
> > - * for backward compatibility.
> > - * @minor: Devnode minor number (zero if not applicable). Kept just
> > - * for backward compatibility.
> > *
> > * .. note::
> > *
> >
>
> I'd say that this is correct based on
> https://patchwork.kernel.org/project/linux-media/patch/[email protected]/
>
>
> Hans, can you please explain this message from you, on 2024-Jan-22, that
> I cannot find in the media patchwork:
It's in linuxtv.org Patchwork here
<URL:https://patchwork.linuxtv.org/project/linux-media/patch/[email protected]/>
and also in the media stage tree (as indicated by the state) but not yet in
master AFAIU.
>
>
> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
>
>
>
> This is an automatic generated email to let you know that the following patch were queued:
>
> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
> Author: Randy Dunlap <[email protected]>
> Date: Fri Dec 22 21:07:07 2023 -0800
>
> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
>
> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Reviewed-by: Laurent Pinchart <[email protected]>
> Signed-off-by: Sakari Ailus <[email protected]>
> Signed-off-by: Hans Verkuil <[email protected]>
>
> include/media/media-entity.h | 4 ----
> 1 file changed, 4 deletions(-)
>
> ---
>
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
> * @info.dev: Contains device major and minor info.
> * @info.dev.major: device node major, if the device is a devnode.
> * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major: Devnode major number (zero if not applicable). Kept just
> - * for backward compatibility.
> - * @minor: Devnode minor number (zero if not applicable). Kept just
> - * for backward compatibility.
> *
> * .. note::
> *
>
>
>
> Thanks.
--
Regards,
Sakari Ailus
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove kerneldoc from missing fields.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/usb/dvb-usb/dvb-usb.h | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/drivers/media/usb/dvb-usb/dvb-usb.h b/drivers/media/usb/dvb-usb/dvb-usb.h
> index 0990aa4a17bb..cbb0541d4dc1 100644
> --- a/drivers/media/usb/dvb-usb/dvb-usb.h
> +++ b/drivers/media/usb/dvb-usb/dvb-usb.h
> @@ -126,8 +126,6 @@ struct usb_data_stream_properties {
> * @caps: capabilities of the DVB USB device.
> * @pid_filter_count: number of PID filter position in the optional hardware
> * PID-filter.
> - * @num_frontends: number of frontends of the DVB USB adapter.
> - * @frontend_ctrl: called to power on/off active frontend.
> * @streaming_ctrl: called to start and stop the MPEG2-TS streaming of the
> * device (not URB submitting/killing).
> * This callback will be called without data URBs being active - data URBs
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The fields are gone, remove their documentation.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> include/media/cec.h | 2 --
> 1 file changed, 2 deletions(-)
>
> diff --git a/include/media/cec.h b/include/media/cec.h
> index d77982685116..10c9cf6058b7 100644
> --- a/include/media/cec.h
> +++ b/include/media/cec.h
> @@ -224,8 +224,6 @@ struct cec_adap_ops {
> * @notifier: CEC notifier
> * @pin: CEC pin status struct
> * @cec_dir: debugfs cec directory
> - * @status_file: debugfs cec status file
> - * @error_inj_file: debugfs cec error injection file
> * @sequence: transmit sequence counter
> * @input_phys: remote control input_phys name
> *
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is gone, remove it.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/pci/dt3155/dt3155.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/pci/dt3155/dt3155.h b/drivers/media/pci/dt3155/dt3155.h
> index c9ce79cb5566..ce1835d9691e 100644
> --- a/drivers/media/pci/dt3155/dt3155.h
> +++ b/drivers/media/pci/dt3155/dt3155.h
> @@ -162,7 +162,6 @@
> * @height: frame height
> * @input: current input
> * @sequence: frame counter
> - * @stats: statistics structure
> * @regs: local copy of mmio base register
> * @csr2: local copy of csr2 register
> * @config: local copy of config register
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is not part of the structure. Remove the doc.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/media/platform/verisilicon/hantro.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/platform/verisilicon/hantro.h b/drivers/media/platform/verisilicon/hantro.h
> index 6f5eb975d0e3..811260dc3c77 100644
> --- a/drivers/media/platform/verisilicon/hantro.h
> +++ b/drivers/media/platform/verisilicon/hantro.h
> @@ -237,7 +237,6 @@ struct hantro_dev {
> * @codec_ops: Set of operations related to codec mode.
> * @postproc: Post-processing context.
> * @h264_dec: H.264-decoding context.
> - * @jpeg_enc: JPEG-encoding context.
> * @mpeg2_dec: MPEG-2-decoding context.
> * @vp8_dec: VP8-decoding context.
> * @hevc_dec: HEVC-decoding context.
>
--
#Randy
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove documentation from missing field.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: Randy Dunlap <[email protected]>
Thanks.
> ---
> drivers/staging/media/meson/vdec/vdec.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/staging/media/meson/vdec/vdec.h b/drivers/staging/media/meson/vdec/vdec.h
> index 0906b8fb5cc6..258685177700 100644
> --- a/drivers/staging/media/meson/vdec/vdec.h
> +++ b/drivers/staging/media/meson/vdec/vdec.h
> @@ -101,7 +101,6 @@ struct amvdec_core {
> * @conf_esparser: mandatory call to let the vdec configure the ESPARSER
> * @vififo_level: mandatory call to get the current amount of data
> * in the VIFIFO
> - * @use_offsets: mandatory call. Returns 1 if the VDEC supports vififo offsets
> */
> struct amvdec_ops {
> int (*start)(struct amvdec_session *sess);
>
--
#Randy
Quoting Ricardo Ribalda (2024-01-26 23:16:06)
> The field is gone, remove the documentation.
Looking at 3e89586a64df ("media: i2c: adv748x: add adv748x driver")
confims it was never added. Must have been an old leftover when I
upstreamed.
Thanks for the fix.
Reviewed-by: Kieran Bingham <[email protected]>
> Signed-off-by: Ricardo Ribalda <[email protected]>
> ---
> drivers/media/i2c/adv748x/adv748x.h | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/media/i2c/adv748x/adv748x.h b/drivers/media/i2c/adv748x/adv748x.h
> index 6f90f78f58cf..d2b5e722e997 100644
> --- a/drivers/media/i2c/adv748x/adv748x.h
> +++ b/drivers/media/i2c/adv748x/adv748x.h
> @@ -173,7 +173,6 @@ struct adv748x_afe {
> *
> * @endpoints: parsed device node endpoints for each port
> *
> - * @i2c_addresses: I2C Page addresses
> * @i2c_clients: I2C clients for the page accesses
> * @regmap: regmap configuration pages.
> *
>
> --
> 2.43.0.429.g432eaa2c6b-goog
>
Il 27/01/24 00:16, Ricardo Ribalda ha scritto:
> Named nested unions need their prefix:
> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: AngeloGioacchino Del Regno <[email protected]>
Il 27/01/24 00:16, Ricardo Ribalda ha scritto:
> Those fields have been removed. They do not need to be documented.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: AngeloGioacchino Del Regno <[email protected]>
Il 27/01/24 00:16, Ricardo Ribalda ha scritto:
> These fields seems to be gone:
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c:57: warning: Excess struct member 'wait_key_frame' description in 'vdec_vp8_slice_info'
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c:166: warning: Excess struct member 'mv_joint' description in 'vdec_vp9_slice_counts_map'
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: AngeloGioacchino Del Regno <[email protected]>
Il 27/01/24 00:16, Ricardo Ribalda ha scritto:
> The field is gone, remove the documentation for it.
>
> Signed-off-by: Ricardo Ribalda <[email protected]>
Reviewed-by: AngeloGioacchino Del Regno <[email protected]>
On 2/5/24 02:29, Hans Verkuil wrote:
> On 27/01/2024 10:57, Sakari Ailus wrote:
>> Hi Ricardo,
>>
>> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
>>> Kerneldoc cannot understand arrays defined like
>>> v4l2_frame_symbol_counts.
>>>
>>> Adding an asterisk to the name does do the trick.
>>>
>>> Disable the kerneldoc notation for now, it is already ignored:
>>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
>>
>> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
>> all.
>>
>> Feel free to, but I can also give it a try.
>>
>
> It would be nice to have this fixed in kerneldoc itself. I'm holding this
> patch back for two weeks to see if someone wants to work on kerneldoc.
>
> If not, then I'll take this anyway to fix the noise in our build.
>
> Note that while this header is indeed ignored in the documentation, that
> is really more a bug and it would be nice to actually include this header
> somewhere in our documentation. So fixing these kerneldoc warnings one way
> or another is something that we should do.
>
It's just waiting for Jon to apply it: (from Sakari)
https://lore.kernel.org/all/[email protected]/
Thanks.
--
#Randy
On 27/01/2024 10:57, Sakari Ailus wrote:
> Hi Ricardo,
>
> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
>> Kerneldoc cannot understand arrays defined like
>> v4l2_frame_symbol_counts.
>>
>> Adding an asterisk to the name does do the trick.
>>
>> Disable the kerneldoc notation for now, it is already ignored:
>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
>
> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
> all.
>
> Feel free to, but I can also give it a try.
>
It would be nice to have this fixed in kerneldoc itself. I'm holding this
patch back for two weeks to see if someone wants to work on kerneldoc.
If not, then I'll take this anyway to fix the noise in our build.
Note that while this header is indeed ignored in the documentation, that
is really more a bug and it would be nice to actually include this header
somewhere in our documentation. So fixing these kerneldoc warnings one way
or another is something that we should do.
Regards,
Hans
On 05/02/2024 11:39, Randy Dunlap wrote:
>
>
> On 2/5/24 02:29, Hans Verkuil wrote:
>> On 27/01/2024 10:57, Sakari Ailus wrote:
>>> Hi Ricardo,
>>>
>>> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
>>>> Kerneldoc cannot understand arrays defined like
>>>> v4l2_frame_symbol_counts.
>>>>
>>>> Adding an asterisk to the name does do the trick.
>>>>
>>>> Disable the kerneldoc notation for now, it is already ignored:
>>>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
>>>
>>> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
>>> all.
>>>
>>> Feel free to, but I can also give it a try.
>>>
>>
>> It would be nice to have this fixed in kerneldoc itself. I'm holding this
>> patch back for two weeks to see if someone wants to work on kerneldoc.
>>
>> If not, then I'll take this anyway to fix the noise in our build.
>>
>> Note that while this header is indeed ignored in the documentation, that
>> is really more a bug and it would be nice to actually include this header
>> somewhere in our documentation. So fixing these kerneldoc warnings one way
>> or another is something that we should do.
>>
>
> It's just waiting for Jon to apply it: (from Sakari)
>
> https://lore.kernel.org/all/[email protected]/
Ah, that patch was CCed to me but not to linux-media, and I only searched linux-media
for it so I missed it. Good news that this is fixed in the right place.
I marked this 17/17 patch as Obsoleted in patchwork.
Regards,
Hans
Hi Hans,
On Mon, Feb 05, 2024 at 11:44:13AM +0100, Hans Verkuil wrote:
> On 05/02/2024 11:39, Randy Dunlap wrote:
> >
> >
> > On 2/5/24 02:29, Hans Verkuil wrote:
> >> On 27/01/2024 10:57, Sakari Ailus wrote:
> >>> Hi Ricardo,
> >>>
> >>> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
> >>>> Kerneldoc cannot understand arrays defined like
> >>>> v4l2_frame_symbol_counts.
> >>>>
> >>>> Adding an asterisk to the name does do the trick.
> >>>>
> >>>> Disable the kerneldoc notation for now, it is already ignored:
> >>>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
> >>>
> >>> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
> >>> all.
> >>>
> >>> Feel free to, but I can also give it a try.
> >>>
> >>
> >> It would be nice to have this fixed in kerneldoc itself. I'm holding this
> >> patch back for two weeks to see if someone wants to work on kerneldoc.
> >>
> >> If not, then I'll take this anyway to fix the noise in our build.
> >>
> >> Note that while this header is indeed ignored in the documentation, that
> >> is really more a bug and it would be nice to actually include this header
> >> somewhere in our documentation. So fixing these kerneldoc warnings one way
> >> or another is something that we should do.
> >>
> >
> > It's just waiting for Jon to apply it: (from Sakari)
> >
> > https://lore.kernel.org/all/[email protected]/
>
> Ah, that patch was CCed to me but not to linux-media, and I only searched linux-media
> for it so I missed it. Good news that this is fixed in the right place.
My bad, somehow I missed linux-media from the distribution. :-(
>
> I marked this 17/17 patch as Obsoleted in patchwork.
Thank you!
--
Regards,
Sakari Ailus