linux-kernel - Re: [PATCH v15 00/29] drm/connector: Create HDMI Connector infrastructure

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Fri, 31 May 2024 21:43:16 +0300
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: Maxime Ripard <mripard@...nel.org>, Maarten Lankhorst
 <maarten.lankhorst@...ux.intel.com>, Thomas Zimmermann
 <tzimmermann@...e.de>, David Airlie <airlied@...il.com>, Daniel Vetter
 <daniel@...ll.ch>, Jonathan Corbet <corbet@....net>, Sandy Huang
 <hjc@...k-chips.com>, Heiko Stübner <heiko@...ech.de>,
 Chen-Yu Tsai
 <wens@...e.org>, Jernej Skrabec <jernej.skrabec@...il.com>, Samuel Holland
 <samuel@...lland.org>, Andy Yan <andy.yan@...k-chips.com>
Cc: Hans Verkuil <hverkuil@...all.nl>, Sebastian Wick
 <sebastian.wick@...hat.com>, Ville Syrjälä
 <ville.syrjala@...ux.intel.com>, dri-devel@...ts.freedesktop.org,
 linux-arm-kernel@...ts.infradead.org, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, linux-media@...r.kernel.org,
 linux-rockchip@...ts.infradead.org, linux-sunxi@...ts.linux.dev, Maxime
 Ripard <mripard@...nel.org>, Dave Stevenson
 <dave.stevenson@...pberrypi.com>, Sui Jingfeng <sui.jingfeng@...ux.dev>,
 Dmitry Baryshkov <dmitry.baryshkov@...aro.org>, Pekka Paalanen
 <pekka.paalanen@...labora.com>, Maíra Canal
 <mcanal@...lia.com>, Andy Yan
 <andyshrk@....com>
Subject: Re: [PATCH v15 00/29] drm/connector: Create HDMI Connector
 infrastructure

On Mon, 27 May 2024, Maxime Ripard <mripard@...nel.org> wrote:
> Let me know what you think,

Sorry to report that this series generates a bunch of kernel-doc
warnings in include/drm/drm_connector.h. Documenting nested struct
members doesn't work as smoothly as you'd expect:

./include/drm/drm_connector.h:1138: warning: Excess struct member 'broadcast_rgb' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'infoframes' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'avi' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'hdr_drm' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'spd' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'vendor' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'is_limited_range' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'output_bpc' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'output_format' description in 'drm_connector_state'
./include/drm/drm_connector.h:1138: warning: Excess struct member 'tmds_char_rate' description in 'drm_connector_state'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'vendor' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'product' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'supported_formats' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'infoframes' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'lock' description in 'drm_connector'
./include/drm/drm_connector.h:2112: warning: Excess struct member 'audio' description in 'drm_connector'

Noticed this when I was rebasing [1]. Having that merged would find
issues in headers at build time instead of 'make htmldocs'.

In the mean time, this is the quick reproducer:

$ scripts/kernel-doc -none include/drm/drm_connector.h


BR,
Jani.

[1] https://lore.kernel.org/r/20240402140136.1722533-1-jani.nikula@intel.com


-- 
Jani Nikula, Intel