Received-SPF: pass (google.com: domain of linux-kernel+bounces-198877-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Maxime Ripard <mripard@kernel.org>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>, Thomas Zimmermann
 <tzimmermann@suse.de>, David Airlie <airlied@gmail.com>, Daniel Vetter
 <daniel@ffwll.ch>, Jonathan Corbet <corbet@lwn.net>, Sandy Huang
 <hjc@rock-chips.com>, Heiko =?utf-8?Q?St=C3=BCbner?= <heiko@sntech.de>,
 Chen-Yu Tsai
 <wens@csie.org>, Jernej Skrabec <jernej.skrabec@gmail.com>, Samuel Holland
 <samuel@sholland.org>, Andy Yan <andy.yan@rock-chips.com>, Hans Verkuil
 <hverkuil@xs4all.nl>, Sebastian Wick <sebastian.wick@redhat.com>, Ville
 =?utf-8?B?U3lyasOkbMOk?= <ville.syrjala@linux.intel.com>,
 dri-devel@lists.freedesktop.org,
 linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, linux-media@vger.kernel.org,
 linux-rockchip@lists.infradead.org, linux-sunxi@lists.linux.dev, Dave
 Stevenson <dave.stevenson@raspberrypi.com>, Sui Jingfeng
 <sui.jingfeng@linux.dev>, Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
 Pekka Paalanen <pekka.paalanen@collabora.com>, =?utf-8?Q?Ma=C3=ADra?= Canal
 <mcanal@igalia.com>, Andy Yan <andyshrk@163.com>
Subject: Re: [PATCH v15 00/29] drm/connector: Create HDMI Connector
 infrastructure
In-Reply-To: <20240603-nippy-ludicrous-caracara-e02e3c@houat>
Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
References: <20240527-kms-hdmi-connector-state-v15-0-c5af16c3aae2@kernel.org>
 <874jadesaj.fsf@intel.com>
 <20240603-nippy-ludicrous-caracara-e02e3c@houat>
Date: Mon, 03 Jun 2024 12:28:51 +0300
Message-ID: <87zfs2cr3g.fsf@intel.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

On Mon, 03 Jun 2024, Maxime Ripard <mripard@kernel.org> wrote:
> Hi Jani,
>
> On Fri, May 31, 2024 at 09:43:16PM GMT, Jani Nikula wrote:
>> On Mon, 27 May 2024, Maxime Ripard <mripard@kernel.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
>
> Thanks for the report and the reproducer. I have to admit I have no idea
> how to fix it, do you have a suggestion?

Some of them can be fixed by adding the parent struct name, like so:

-                * @broadcast_rgb: Connector property to pass the
+                * @hdmi.broadcast_rgb: Connector property to pass the

but I think even that falls apart at some point. :(

In the end might be easier to separate the struct definitions to reduce
nesting.


BR,
Jani.


-- 
Jani Nikula, Intel