Linux kernel staging patches
 help / color / mirror / Atom feed
* [PATCH 0/2] media: atomisp: Remove doxygen comments
@ 2026-06-29 11:48 Ricardo Ribalda
  2026-06-29 11:48 ` [PATCH 1/2] media: atomisp: Demote all broken kernel-doc comments Ricardo Ribalda
  2026-06-29 11:48 ` [PATCH 2/2] media: atomisp: Demote all " Ricardo Ribalda
  0 siblings, 2 replies; 6+ messages in thread
From: Ricardo Ribalda @ 2026-06-29 11:48 UTC (permalink / raw)
  To: Andy Shevchenko, Hans de Goede, Mauro Carvalho Chehab,
	Sakari Ailus, Greg Kroah-Hartman
  Cc: linux-kernel, linux-media, linux-staging, Ricardo Ribalda

The code was originally designed to use doxygen and that confuses
kerneldoc.

This series starts with a manual patch to remove all the comments that
confuses kerneldoc, and then with a patch to demote all doxygen
comments.

The goal is to add media-ci coverage for atomisp:
- https://gitlab.freedesktop.org/linux-media/media-ci/-/blob/main/test-kernel-doc.sh?ref_type=heads#L46

If needed, in future patches, we can convert the comments to kerneldoc,
I have made an experiment with Gemini and it threw pretty good results.

Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
Ricardo Ribalda (2):
      media: atomisp: Demote all broken kernel-doc comments
      media: atomisp: Demote all kernel-doc comments

 drivers/staging/media/atomisp/i2c/ov2722.h         |   2 +-
 .../media/atomisp/pci/atomisp_compat_css20.c       |   2 +-
 drivers/staging/media/atomisp/pci/atomisp_subdev.h |   2 +-
 .../pci/base/circbuf/interface/ia_css_circbuf.h    |  40 +-
 .../base/circbuf/interface/ia_css_circbuf_comm.h   |   4 +-
 .../base/circbuf/interface/ia_css_circbuf_desc.h   |  14 +-
 .../pci/camera/util/interface/ia_css_util.h        |   2 +-
 .../pci/css_2401_system/host/csi_rx_private.h      |  18 +-
 .../pci/css_2401_system/host/isys_irq_private.h    |   4 +-
 .../host/isys_stream2mmio_private.h                |  12 +-
 .../pci/css_2401_system/host/pixelgen_private.h    |   8 +-
 .../atomisp/pci/css_2401_system/pixelgen_global.h  |   2 +-
 .../pci/hive_isp_css_common/timed_ctrl_global.h    |   2 +-
 .../device_access/device_access.h                  |   2 +-
 .../pci/hive_isp_css_include/host/csi_rx_public.h  |  18 +-
 .../host/isys_stream2mmio_public.h                 |  12 +-
 .../pci/hive_isp_css_include/host/mmu_public.h     |  30 +-
 .../hive_isp_css_include/host/pixelgen_public.h    |   8 +-
 .../pci/hive_isp_css_include/host/tag_public.h     |   4 +-
 .../pci/hive_isp_css_include/platform_support.h    |   2 +-
 .../pci/hive_isp_css_include/type_support.h        |   2 +-
 drivers/staging/media/atomisp/pci/ia_css_3a.h      |  30 +-
 .../staging/media/atomisp/pci/ia_css_acc_types.h   | 222 ++++++-----
 drivers/staging/media/atomisp/pci/ia_css_buffer.h  |  39 +-
 drivers/staging/media/atomisp/pci/ia_css_dvs.h     |   6 +-
 drivers/staging/media/atomisp/pci/ia_css_env.h     |  58 ++-
 .../media/atomisp/pci/ia_css_event_public.h        | 111 +++---
 .../staging/media/atomisp/pci/ia_css_firmware.h    |   4 +-
 .../media/atomisp/pci/ia_css_frame_format.h        | 104 ++++--
 .../media/atomisp/pci/ia_css_frame_public.h        | 120 +++---
 .../staging/media/atomisp/pci/ia_css_host_data.h   |   4 +-
 .../staging/media/atomisp/pci/ia_css_input_port.h  |  22 +-
 drivers/staging/media/atomisp/pci/ia_css_irq.h     |  88 ++---
 .../staging/media/atomisp/pci/ia_css_metadata.h    |  25 +-
 .../staging/media/atomisp/pci/ia_css_pipe_public.h | 192 ++++++----
 drivers/staging/media/atomisp/pci/ia_css_prbs.h    |  14 +-
 .../staging/media/atomisp/pci/ia_css_properties.h  |   7 +-
 drivers/staging/media/atomisp/pci/ia_css_stream.h  |   2 +-
 .../media/atomisp/pci/ia_css_stream_public.h       | 179 +++++----
 drivers/staging/media/atomisp/pci/ia_css_timer.h   |  23 +-
 drivers/staging/media/atomisp/pci/ia_css_types.h   | 414 ++++++++++++---------
 .../pci/isp/kernels/anr/anr_1.0/ia_css_anr_types.h |   2 +-
 .../pci/isp/kernels/bnlm/ia_css_bnlm_types.h       |  33 +-
 .../isp/kernels/bnr/bnr2_2/ia_css_bnr2_2_types.h   |  38 +-
 .../pci/isp/kernels/cnr/cnr_2/ia_css_cnr2_types.h  |  56 ++-
 .../conversion_1.0/ia_css_conversion_types.h       |  10 +-
 .../pci/isp/kernels/csc/csc_1.0/ia_css_csc_types.h |  16 +-
 .../pci/isp/kernels/ctc/ctc2/ia_css_ctc2_param.h   |   2 +-
 .../pci/isp/kernels/ctc/ctc2/ia_css_ctc2_types.h   |   7 +-
 .../pci/isp/kernels/ctc/ctc_1.0/ia_css_ctc_types.h |  99 +++--
 .../pci/isp/kernels/de/de_1.0/ia_css_de_types.h    |  31 +-
 .../pci/isp/kernels/de/de_2/ia_css_de2_types.h     |  29 +-
 .../pci/isp/kernels/dp/dp_1.0/ia_css_dp_types.h    |  38 +-
 .../pci/isp/kernels/dpc2/ia_css_dpc2_types.h       |   6 -
 .../pci/isp/kernels/eed1_8/ia_css_eed1_8_types.h   | 107 +++---
 .../isp/kernels/fc/fc_1.0/ia_css_formats_types.h   |  13 +-
 .../pci/isp/kernels/fpn/fpn_1.0/ia_css_fpn_types.h |  35 +-
 .../pci/isp/kernels/gc/gc_1.0/ia_css_gc_types.h    |  49 ++-
 .../pci/isp/kernels/gc/gc_2/ia_css_gc2_types.h     |  14 +-
 .../atomisp/pci/isp/kernels/hdr/ia_css_hdr_types.h |  51 +--
 .../ipu2_io_ls/common/ia_css_common_io_param.h     |   2 +-
 .../ipu2_io_ls/common/ia_css_common_io_types.h     |   2 +-
 .../yuv444_io_ls/ia_css_yuv444_io.host.h           |   2 +-
 .../yuv444_io_ls/ia_css_yuv444_io_param.h          |   2 +-
 .../yuv444_io_ls/ia_css_yuv444_io_types.h          |   2 +-
 .../kernels/macc/macc1_5/ia_css_macc1_5_types.h    |  17 +-
 .../isp/kernels/macc/macc_1.0/ia_css_macc_types.h  |  16 +-
 .../pci/isp/kernels/ob/ob2/ia_css_ob2_types.h      |  36 +-
 .../pci/isp/kernels/ob/ob_1.0/ia_css_ob_types.h    |  81 ++--
 .../output/output_1.0/ia_css_output_types.h        |   4 +-
 .../pci/isp/kernels/s3a/s3a_1.0/ia_css_s3a_types.h | 328 ++++++++++------
 .../pci/isp/kernels/sc/sc_1.0/ia_css_sc_types.h    | 102 +++--
 .../kernels/sdis/common/ia_css_sdis_common_types.h | 180 +++++----
 .../isp/kernels/sdis/sdis_1.0/ia_css_sdis_types.h  |  36 +-
 .../isp/kernels/sdis/sdis_2/ia_css_sdis2_types.h   |  40 +-
 .../pci/isp/kernels/tdf/tdf_1.0/ia_css_tdf_types.h |  44 ++-
 .../pci/isp/kernels/tnr/tnr3/ia_css_tnr3_types.h   |  37 +-
 .../pci/isp/kernels/tnr/tnr_1.0/ia_css_tnr_types.h |  43 ++-
 .../pci/isp/kernels/vf/vf_1.0/ia_css_vf_param.h    |   2 +-
 .../pci/isp/kernels/vf/vf_1.0/ia_css_vf_types.h    |   2 +-
 .../pci/isp/kernels/wb/wb_1.0/ia_css_wb_types.h    |  45 ++-
 .../pci/isp/kernels/xnr/xnr_1.0/ia_css_xnr_types.h |  10 +-
 .../isp/kernels/xnr/xnr_3.0/ia_css_xnr3_types.h    |  44 +--
 .../pci/isp/kernels/ynr/ynr_1.0/ia_css_ynr_types.h |  88 +++--
 .../pci/isp/kernels/ynr/ynr_2/ia_css_ynr2_types.h  | 153 +++++---
 .../pci/isp/modes/interface/input_buf.isp.h        |   2 +-
 .../pci/runtime/binary/interface/ia_css_binary.h   |   2 +-
 .../pci/runtime/bufq/interface/ia_css_bufq.h       |  26 +-
 .../pci/runtime/debug/interface/ia_css_debug.h     |  40 +-
 .../runtime/debug/interface/ia_css_debug_pipe.h    |  10 +-
 .../pci/runtime/eventq/interface/ia_css_eventq.h   |   4 +-
 .../isp_param/interface/ia_css_isp_param_types.h   |   4 +-
 .../pci/runtime/isys/interface/ia_css_isys.h       |   8 +-
 .../runtime/pipeline/interface/ia_css_pipeline.h   |  10 +-
 .../pci/runtime/rmgr/interface/ia_css_rmgr.h       |   4 +-
 .../pci/runtime/rmgr/interface/ia_css_rmgr_vbuf.h  |  18 +-
 .../pci/runtime/spctrl/interface/ia_css_spctrl.h   |  15 +-
 .../runtime/spctrl/interface/ia_css_spctrl_comm.h  |  12 +-
 .../tagger/interface/ia_css_tagger_common.h        |   4 +-
 drivers/staging/media/atomisp/pci/sh_css.c         |  18 +-
 .../staging/media/atomisp/pci/sh_css_internal.h    |  53 ++-
 drivers/staging/media/atomisp/pci/sh_css_mipi.c    |   4 +-
 drivers/staging/media/atomisp/pci/sh_css_params.c  |   4 +-
 drivers/staging/media/atomisp/pci/sh_css_params.h  |  10 +-
 drivers/staging/media/atomisp/pci/sh_css_sp.h      |  14 +-
 drivers/staging/media/atomisp/pci/system_global.h  |   4 +-
 106 files changed, 2413 insertions(+), 1661 deletions(-)
---
base-commit: 253355887a1ab0ac8f33b356c7c1140eee554d18
change-id: 20260611-atomisp-kerneldoc-simple-23f1f46357f3

Best regards,
-- 
Ricardo Ribalda <ribalda@chromium.org>


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2026-07-15 12:39 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-06-29 11:48 [PATCH 0/2] media: atomisp: Remove doxygen comments Ricardo Ribalda
2026-06-29 11:48 ` [PATCH 1/2] media: atomisp: Demote all broken kernel-doc comments Ricardo Ribalda
2026-06-29 15:12   ` Andy Shevchenko
2026-07-15 12:39   ` Sakari Ailus
2026-06-29 11:48 ` [PATCH 2/2] media: atomisp: Demote all " Ricardo Ribalda
2026-06-29 15:14   ` Andy Shevchenko

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox