| Message ID | 20240309-mediatek-typos-v1-3-fa4aeb59306c@collabora.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Mediatek VCODEC documentation improvements | expand |
Il 09/03/24 16:08, Sebastian Fricke ha scritto: > The function descriptions where falsely copy pasted from another entry, > write more fitting descriptions for the functions. > > Signed-off-by: Sebastian Fricke <sebastian.fricke@collabora.com> Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com> > --- > .../platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h | 6 ++++-- > 1 file changed, 4 insertions(+), 2 deletions(-) > > diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h > index 6f624c266246..2d845b1307b6 100644 > --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h > +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h > @@ -185,7 +185,7 @@ void mtk_vdec_h264_get_ref_list(u8 *ref_list, > void *mtk_vdec_h264_get_ctrl_ptr(struct mtk_vcodec_dec_ctx *ctx, int id); > > /** > - * mtk_vdec_h264_fill_dpb_info - get each CID contrl address. > + * mtk_vdec_h264_fill_dpb_info - Fill the decoded picture buffer info > * > * @ctx: v4l2 ctx > * @decode_params: slice decode params > @@ -225,7 +225,9 @@ void mtk_vdec_h264_copy_slice_hd_params(struct mtk_h264_slice_hd_param *dst_para > const struct v4l2_ctrl_h264_decode_params *dec_param); > > /** > - * mtk_vdec_h264_copy_scaling_matrix - get each CID contrl address. > + * mtk_vdec_h264_copy_scaling_matrix - Copy the scaling matrix from a source to > + * a destination. > + * (for example into the slice parameters) That should be a short description; the "for example into the slice parameters" along with a longer description go in the long description part of the doc. /* * mtk_vdec_h264_copy_scaling_matrix - Copy scaling matrix from HW to driver * @dst_matrix: ..... * @src_matrix: .... * * This function copies the scaling matrix from the hardware decoder (format? * structs? registers? what?) to the driver's scaling matrix structure, because * this that and the other tell me why we would ever need to do this, as this * is a long description of what this function does. * If a long description is not needed, just avoid it, of course. * * Return: some value for something, some other for something else * * This return value, as described, is so useful! :-) */ Cheers, Angelo
diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h index 6f624c266246..2d845b1307b6 100644 --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h @@ -185,7 +185,7 @@ void mtk_vdec_h264_get_ref_list(u8 *ref_list, void *mtk_vdec_h264_get_ctrl_ptr(struct mtk_vcodec_dec_ctx *ctx, int id); /** - * mtk_vdec_h264_fill_dpb_info - get each CID contrl address. + * mtk_vdec_h264_fill_dpb_info - Fill the decoded picture buffer info * * @ctx: v4l2 ctx * @decode_params: slice decode params @@ -225,7 +225,9 @@ void mtk_vdec_h264_copy_slice_hd_params(struct mtk_h264_slice_hd_param *dst_para const struct v4l2_ctrl_h264_decode_params *dec_param); /** - * mtk_vdec_h264_copy_scaling_matrix - get each CID contrl address. + * mtk_vdec_h264_copy_scaling_matrix - Copy the scaling matrix from a source to + * a destination. + * (for example into the slice parameters) * * @dst_matrix: scaling list params for hw decoder * @src_matrix: scaling list params from user driver
The function descriptions where falsely copy pasted from another entry, write more fitting descriptions for the functions. Signed-off-by: Sebastian Fricke <sebastian.fricke@collabora.com> --- .../platform/mediatek/vcodec/decoder/vdec/vdec_h264_req_common.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)